NLW NPS

This repository represents a backend developed for the app "NLW".

Getting Started

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.

Prerequisites

What things you need to install the software and how to install them

node
npm 

Installing

A step by step series of examples that tell you how to get a development env running

To install node and npm, go to the link below and download the LTS version

https://nodejs.org/en/download/

Clone this repository, open up on your favorite code editor and then run the command line below to install all needed packages to run in your local machine

npm install or yarn add

After that, run de command:

npm run dev or yarn dev

Running the tests

npm test or yarn test

Break down into end to end tests

all tests developed are integration tests

Give an example

Built With

• NodeJS - The JS framework used
• Express - Framework NodeJS responsible for management the routes of the API
• Typescript - TypeScript is an open-source language which builds on JavaScript
• Jest - Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
• TypeORM - TypeORM is an Object Relational Mapper library running in node. js and written in TypeScript.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

• André Macena - Initial work - NLW-NPS

See also the list of contributors who participated in this project.

Acknowledgments

• Inspiration in classes of Rocketseat