💻 Project Name 💻

🏃 Quick Start

• Create .env file based on .env.example in the project folder
• Change tokens of JWT_SECRET and API_TOKEN_SALT in .env file
• Install dependencies using yarn or npm install
• Start the project for development using yarn develop or npm run develop

📝 Description

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus commodo, sem nec pretium luctus, erat elit molestie erat, eget facilisis massa sapien et quam. Etiam dolor urna, imperdiet et ligula ut, malesuada vulputate tortor. Vestibulum finibus, turpis ut ultricies euismod, eros est congue neque, vel accumsan odio massa ultricies orci.

➕ Dependencies

These tecnologies listed below are required to run the project properly:

• Node >= v16.13
• NPM => v8.1.2
• Docker (optional) >= 20.10.12

To install the dependencies, use yarn or npm install.

📁 Setting up database

• Start docker containers using docker-compose up
• Create tables by running migrations: yarn migrate or npm run migrate

🔨 Building the project

• Use yarn build or npm run build

🚀 Running the app

• Start docker containers using docker-compose up
• Development: yarn develop or npm run develop
• Production: yarn start or npm start

⚠️ Note

🚧 Project is currently in development. 🚧