badhan-doc

The documentation of Badhan, BUET Zone backend server. It might be used as a frontend to test all the routes.

Run Locally

• Clone the repo
• Run npm install inside the cloned directory

Test the Routes

Go to https://badhan-doc.herokuapp.com

Steps required for new feature

Steps for the design

• Design new UI in Figma
• Meetings

Steps for the backend:

• Schemas
• Main controller
• Validation and sanitization
• Logging
• Relevant security middlewares
• Rate limiter
• Guest API
• Automated testing for main and guest route
• New openapi documentation
• Testing from openapi documentation

Steps for the frontend:

• Build UI
• Connect UI to backend
• Automate UI test

Steps for finalization:

• Deploy test site for testing
• Deploy Github release
• Deploy main site and android

Software Architecture of Badhan, BUET Zone

Summary

Details

Currently Focused Issues

https://drive.google.com/file/d/1PcJ_ZWniQ3sPJ-_vAivf1SLrhXhaZkC5/view?usp=sharing