API FOR BIZZ-IT

---

Description

This is a REST API for Bizz-It, a mobile app to connect potential franchisees and franchisors more easily. It is built with Node.js, Express, and Google Cloud.

Installation

1. Clone this repository

git clone

2. Install dependencies

npm install

3. Create a .env file based on the .env.example file contain these following environment variables:

DB_NAME= # name of your database
DB_USERNAME= # username of your database
DB_PASSWORD= # password of your database
JWT_SECRET= # secret key for JWT
GCLOUD_STORAGE_BUCKET= # name of your GCP storage bucket
PROJECT_ID= # your GCP project ID
PORT= # port for your server
NODE_ENV= # environment for your server
EMAIL_USERNAME= # email for email-based otp
EMAIL_PASSWORD= # password for email-based otp

4. Create a credentials.json file for your GCP service account. You can find the instructions here.

5. Run the development server

npm run server

Libraries Used

• Express - Node.js web application framework
• Sequelize - Promise-based Node.js ORM for Postgres
• mysql2 - MySQL client for Node.js
• @google-cloud/storage - Google Cloud Storage client library
• bcrypt - Library for hashing passwords
• jsonwebtoken - Library for generating JWT
• nodemailer - Library for sending emails
• multer - Middleware for handling multipart/form-data
• dotenv - Library for loading environment variables
• cors - Middleware for enabling CORS
• joi - Library for validating data

API Documentation

You can find the documentation for this API here.

GCP Deployment

This API is using Google Cloud Platform for deployment.

GCP Services used:

• App Engine
• Cloud SQL
• Cloud Storage

GCP Architecture