Giter VIP home page Giter VIP logo

footystatsapi's Introduction

footyStatsAPI

Introduction

Node API with a single endpoint to return player stats by season, specific month or specific week

Getting Started

You will need to have the appropriate version of Node installed, I recommend using NVM and adding the 'Deeper Shell Integration' as that will utilise the .nvmrc to switch to the relevant version of Node for the project.

Once Node is installed you will need to run npm install to add the dependencies.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode. The app runs on http://localhost:3001.

npm run start:dev

Runs the app in the development mode. This uses nodemon to restart the server whenever changes are made to the code. The app runs on http://localhost:3001.

npm test

Runs the test scripts.

The matcher looks for any files that include .spec.js and I have structured the application by feature. For example, for the stats endpoint we have the associated controller, router, queryBuilder and tests in the src/stats directory.

Pre-commit hook

When committing a pre-commit hook uses a combination of ESLint and Prettier to:

  • help identify potential security hotspots, via eslint-plugin-security
  • check there are no syntax errors
  • consistently format the code

Gotchas

To get this application working you need to have a locally running version of MySQL with credentials matching those in src/db/connection.js as well as the seed file.

footystatsapi's People

Contributors

adiecodes avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.