clebim / cardapio-online-backend

backend of an online menu application for any restaurant / bar

Express Application for Cardapio-Online project

Technologies   |    Getting started   

About the project

This api provides a online menu for any bar, restaurant.

This project contains: sending emails, Background jobs, auth JWT image uploads, injection of dependencies.

🚀 Technologies

Technologies that I used to develop this api

• Node.js
• TypeScript
• Express
• tsyringe
• TypeORM
• JWT-token
• PostgreSQL
• Date-fns
• Jest
• SuperTest
• Eslint
• Prettier
• EditorConfig

Requirements

• Node.js
• Yarn or npm
• Instances of PostgreSQL or any other SQL database
• Instance of Redis

💻 Getting started

Clone the project and access the folder

$ git clone https://github.com/clebim/Cardapio-Online.git && cd Cardapio-Online

# Install the dependencies
$ yarn

# Create the instances of postgreSQL
 - any name to api
 - db_test to database used to tests


# Create the instance of redis

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables in .env and .env.test
# Do not change the NODE_ENV variable in .env.test
# The aws variables do not need to be filled for dev environment
$ cp .env.example .env

# configure ormconfig.json with your settings following ormconfig.exemple.json
$ cp ormconfig.example.json ormconfig.json

# Once the services are running, run the migrations
$ yarn typeorm migration:run

# run command `test` to verify that everything is working correctly
$ yarn test

#run background jobs
$ yarn queue

# To finish, run the api service
$ yarn dev:server


# Well done, project is started!