/emufc-api

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

EMUFC-API

Tech

  • Mocha with Chai for tests.
  • Loadtest for loadtests.
  • Sequelize as ORM with MySQL as database with Sequelize-CLI helping to create models/migration files and execute them.
  • Eslint used to standardize the code in the project, so, everyone can helps to improve the code and bugfixes. :)

Installation

Recommended to use Node.js v8+ to run the project.

Install the dependencies and devDependencies and start the server.

$ cd emufc-api
$ npm install

Development

Want to contribute? Great!

Please, first configure ./server/src/config/database.js file or use configured variables before running commands.

  • To run the app in development mode:
$ npm run dev
  • Running the app in production mode:
$ npm start
  • Running tests:
$ npm test
  • Running loadtest:

You need to start the server and run the tests on another terminal.

$ npm run loadtest

Model Associations:

  • Place has many Equipment.
  • Responsible has many Equipment
  • Equipment belongs to Place and Responsible.