README.md

Project API

Description

Technologies   |    How To Use   |    License

🚀 Technologies

This project was developed with the following technologies:

• Bcrypt Js
• Cors
• Dotenv
• EsLint
• Express Async Errors
• Express
• Helmet
• Json Web Token
• Multer
• Nodemon
• Pg-hstore
• Pg
• Prettier
• Sequelize-cli
• Sequelize
• Sucrase
• Youch
• Yup

ℹ️ How To Use

To clone and run this application, you'll need Git, Node.js v10.16 or higher + npm v6.1 or higher installed on your computer. From your command line:

# Clone this repository
$ git clone [email protected]:accalia-io/accalia-tools-template-API.git

# Go into the repository
$ cd accalia-tools-template-API

# Copy env informations
$ cp .env.example .env

# Install dependencies
$ yarn install

# Run migrations to your database
$ yarn migrate

# Run seeds to your database
$ yarn migrate

# Start the backend server
$ yarn dev

# Start the Queue
$ yarn queue

📝 License

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

---

Made with ♥ by Accalia.io 👋 Get in touch!