Ong-donation-api

Author: Wesley Araujo

➡ Contents

• Technologies
• Features
• Installation
• Getting Started

⬇ Technologies

Back-end

• Node.js
• Express
• typescript
• typeorm
• dotEnv
• yup
• jest
• JWT
• bcrypt

⬇ Features

• (Back-end) register/list/update/delete Ongs
• (Back-end) register/list/delete Types/Category
• (Back-end) register/list/delete Donations

⬇ Installation

You need to install Node.js and Yarn first and then, to clone the project via HTTPS, run this command:

git clone https://github.com/W-araujo/ong-donation-api.git

(Back-end) Install dependecies

npm install

yarn install

⬇ Getting Started

Back-end

• Create your enviroment variables based on the examples of .env.example
• Run this code to create the database tables npm run typeorm migration:run
• (optional) To delete the database tables use the command npm run typeorm migration:revert
• To start the server with docker docker-compose up if not, install the docker