https://github.com/dhartisangani/shrtnr-backend
Shrtnr.tech provides users with the ability to generate shortened URLs for their online content & analytics feature that allows users to track the number of clicks received on each shortened link.
https://github.com/dhartisangani/shrtnr-backend
azure bcrypt express google-oauth2 jwt mongodb mongoose mutler nodejs swagger url-shortener
Last synced: 2 months ago
JSON representation
Shrtnr.tech provides users with the ability to generate shortened URLs for their online content & analytics feature that allows users to track the number of clicks received on each shortened link.
- Host: GitHub
- URL: https://github.com/dhartisangani/shrtnr-backend
- Owner: dhartisangani
- Created: 2024-11-15T23:15:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-15T23:15:24.000Z (over 1 year ago)
- Last Synced: 2025-01-22T18:29:24.407Z (over 1 year ago)
- Topics: azure, bcrypt, express, google-oauth2, jwt, mongodb, mongoose, mutler, nodejs, swagger, url-shortener
- Language: JavaScript
- Homepage: https://shrtnr.tech/
- Size: 3.12 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Shrtnr 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
```sh
https://github.com/shrtnr-tech/backend.git
```
3. Open the folder containing the cloned repository
4. Install the required packages, libraries and dependencies
```sh
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:-
```sh
yarn run dev
```
7. Open http://localhost:8080/api-explorer/ to view the API documentation.
## PHI (Φ)
### Team members:
* [Dharti Sangani](https://github.com/dhartisangani)
* [Raj Varsani](https://github.com/RajVarsani)