Shrtnr Backend

Explore Backend 🔗

Technologies

Project is created with:

• nodejs version: 16.13.0
• express version: 4.17.1
• mongoose version: 5.11.17
• jsonwebtoken version: 8.5.1
• Google Oauth
• multer version: 1.4.4
• bcrypt version: 5.0.1
• deployment: Microsoft azure
• swagger

Getting Started

1. Fork the repository
2. Clone the repository

https://github.com/shrtnr-tech/backend.git

3. Open the folder containing the cloned repository
4. Install the required packages, libraries and dependencies

yarn install

5. Custom API keys can be set up in a .env file. The format for .env file can be found in .env.example.
6. Start the project using:-

yarn run dev

7. Open http://localhost:8080/api-explorer/ to view the API documentation.

PHI (Φ)

Team members:

• Master Ayush
• Raj Varsani