Skip to content

Latest commit

 

History

History
78 lines (47 loc) · 1.47 KB

README.md

File metadata and controls

78 lines (47 loc) · 1.47 KB
Raw

NodeJS GraphQL API

A NodeJS API based in GraphQL using Typescript, MySQL, Sequelize and JWT.

Prerequisites

You will need NodeJS, Typescript, Sequelize and MySQL installed.

  • NodeJS - The javascript framework used
  • MySQL - Database used

Typescript and Sequelize can be installed by Node Package Manager with following commands

npm install -g typescript sequelize

Installing

Now, when you have all prerequisites, you will enter in project folder and install dependencies with NPM

npm install

Running the tests

To run the project tests is very simple

Check all dependencies is installed

npm test

You can also see the test coverage

npm run coverage

It will create a directory in root folder called "coverage" with a detailed Web page.

Run project as Development

To run project as development mode, you just run following commands in two different terminals.

npm run gulp

And then

npm run dev

Run project as Production

To run project as production mode, you just run following command.

npm start

Authors

Contributors

This app was created during a "Udemy Course"

Criando API's com Node.js, GraphQL, JWT, Sequelize e TS

Extra Details

This app isn't finished, is just for learning and training.