basic example api nodejs with a begin configurations.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
stable current version of node, npm, yarn and database postgresql
A step by step that tell you how to get a development env running
First
Clone the project
Second
Execute `yarn` for installing dependences
Third
Duplicate `.env.example` to create `.env` with your basic configs
Finishing
Execute `yarn dev` for executing api
Execute `yarn test` for testing api
- Expressjs - Fast, unopinionated, minimalist web framework for Node.js.
- Sucrase - Sucrase is an alternative to Babel that allows super-fast development builds.
- Eslint - Find and fix problems in your JavaScript code.
- Prettier - Prettier is an opinionated code formatter.
- Nodemon - Nodemon for reload automatically.
- EditorConfig - EditorConfig helps maintain consistent coding styles for multiple developers and editors.
- Sequelize - Sequelize is a promise-based Node.js ORM.
- Jest - Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
- Supertest - Super-agent driven library for testing node.js HTTP servers using a fluent API.
- Factory Girl - A factory library for node.js and the browser inspired by factory_girl.
- Faker - generate massive amounts of realistic fake data in Node.js and the browser.
This project is licensed under the MIT License - see the LICENSE file for details