Introduction

badhan-backend repository consists of the code for the main backend for the android app and website of Badhan, BUET Zone. This repository is a part of the Badhan, BUET Zone Github Organization. The central documentation of the organization can be found here

Developers Involved

• Mir Mahathir Mohammad
• Sumaiya Azad

Technology Stack

• Node.js
• Express
• Typescript
• MongoDB
• Mongoose

Description

badhan-backend is a REST API consisting of route endpoints that end up adding, editing, getting and deleting data from a MongoDB database and sends responses as JSON to a web client. The list of route names can be found here. These routes can be accessed by curl. For example, type the following command on a terminal of your PC to test whether the backend is active:

curl https://badhan-buet.uc.r.appspot.com

Result: {"status":"OK","statusCode":200,"message":"Badhan API is online. environment: production"}

Deployment

The code consists of two deployments: the production deployment and the test deployment. The databases of these deployments are separate. The testing deployment is used for testing purposes without hampering the production database and deployment. You can check whether these deployments are active using the following commands:

Production Deployment: curl https://badhan-buet.uc.r.appspot.com

Response: {"status":"OK","statusCode":200,"message":"Badhan API is online. environment: production"}

Testing Deployment: curl https://badhan-buet-test.uc.r.appspot.com

Response: {"status":"OK","statusCode":200,"message":"Badhan API is online. environment: development"}

Procedure for Local Setup (with Docker)

• Install Docker.
• Clone this repository: git clone https://github.com/Badhan-BUET-Zone/badhan-backend.
• Run bin/install from inside the cloned repo.
• Get .env.development from me and put the file in the cloned repository.
• Run bin/up to start the server.
• Run curl http://localhost:3000 in another terminal. You should see the response: {"status":"OK","statusCode":200,"message":"Badhan API is online. environment: development"}

Procedure for Local Setup (without Docker)

• Clone this repository: git clone https://github.com/Badhan-BUET-Zone/badhan-backend.
• Change directory to badhan-backend folder.
• Run npm i.
• Get .env.development from me and put the file in the cloned repository.
• Run npm run serve
• Run curl http://localhost:3000 in another terminal. You should see the response: {"status":"OK","statusCode":200,"message":"Badhan API is online. environment: development"}

That's it. The badhan-backend is now running in your local machine.