gustav-dev17 / regg-api

Regg API

A complete API for a moving furniture delivery application, encompassing user registration and authentication, order management, real-time delivery status and payment processing.

🧬 Cloning this project

1. To clone this project with command line you must have Git installed on your machine. On your terminal run:

git clone https://github.com/amazonsoft-tech/regg-backend.git

2. Access the root folder:

cd regg-backend

💿 Installing dependencies

1. You must have Yarn or NPM installed so you can install the dependencies that this project demands. In the root directory, run:

yarn

in case you have NPM instead, just run:

npm install

🚀 Running this API locally

1. Duplicate the file .env.example and rename one of them to .env

2. Add the environment variables in the newly created .env file

DATABASE_URL =
SECRET = 

3. Generate prisma schema with:

npx prisma generate

4. Sync the database with the prisma schema with:

npx prisma db push

5. To run this API, run one of the following commands below:

yarn dev

or

npm run dev

🛠️ Technologies used in this project

• Typescript – Javascript superset, adding static typing and other features
• NodeJS – Javascript execution environment outside the browser
• ExpressJs – Framework for NodeJs web applications
• Prisma ORM – ORM that makes working with databases easy for application developers and features
• MongoDB – Open source NoSQL database management program
• And more...