Survey-research is an application built on Node.js

Technologies |  Getting Started |  How To Contribute | 

👨🏻‍💻 About the project

The NPS-Survey is an API that consists of calculating the company's NPS. In this application, we register users, register surveys, send emails to users to answer satisfaction surveys and with that, we can perform the NPS calculation(diagram). Using Typescript and Express for route management, TypeORM for data manipulation, automated tests.

🚀 Technologies

Technologies that I used to develop this app

• NodeJS
• TypeScript
• Express
• TypeORM
• SQLite
• Jest
• Nodemailer
• Ethereal-Email
• Beekeeper-Studio
• Insomnia
• VS Code with ESLInt, and Prettier RC

💻 Getting started

Requirements

• Node.js
• Yarn or npm

Clone the project and access the folder

$ git clone https://github.com/francianepovoa/survey-research.git

$ cd survey-research

Follow the steps below to start application

# Install the dependencies
$ yarn

# To start the server run
$ yarn dev

#The application can be accessed at 
$ http://localhost:3333

Follow the steps below to start the automated tests

# To start the automated tests run
$ yarn test

🤔 How to contribute

**Follow the steps below **

# Clone your fork
$ git clone https://github.com/francianepovoa/survey-research.git

$ cd survey-research

# Create a branch with your feature
$ git checkout -b your-feature

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature

After your pull request is merged, you can delete your branch

📝 License

This project is under the MIT license. See the LICENSE for more information.

Made with ♥ by Franciane Póvoa 👋 Get in touch!