diff --git a/README.md b/README.md index d229875..e1f13ed 100644 --- a/README.md +++ b/README.md @@ -1 +1,94 @@ -### Prototype for URL Shortening service for GDSC NITS +# Prototype for URL Shortening service for GDSC NITS + +This project is a URL shortener built with Express.js, Prisma, and MongoDB. It allows users to shorten long URLs into more manageable and shareable links. + + + +## Getting Started + +Prerequisites +Node.js (>= version 14) +MongoDB (Make sure MongoDB is installed and running) +## Installation + +Clone the repository: +```bash + git clone https://github.com/gdsc-nits-org/proto-shorturl-backend.github + +``` + +Change into the project directory: +```bash + cd url-shortener + +``` +Install dependencies: +```bash + npm install + +``` + +Create a '.env' file in the root directory and set the following environment variables: +```bash + PORT=3000 + MONGODB_URI=mongodb://localhost:27017/url-shortener + +``` +Adjust the 'PORT' and 'MONGODB_URI' values as needed. + + + +## Database Setup + +1. Ensure that your MongoDB server is running. +2. Create a database named 'url-shortener' (or the name specified in your '.env' file). +## Database Setup + +1. Ensure that your MongoDB server is running. +2. Create a database named 'url-shortener' (or the name specified in your '.env' file). +## Running Tests + +To run tests, run the following command + +```bash + npm start +``` + + +## API Endpoints + +1. Endpoint: 'POST/api/shorten'. +2. Request Body: + + +```bash + { + "url": "https://example.com" +} + +``` +3. Responses: + +```bash + { + "originalUrl": "https://example.com", + "shortUrl": "http://localhost:3000/abc123" +} + + +``` +#### Redirect to Original URL: + +1. Endpoint: GET /:shortCode +2. Redirects to the original long URL associated with the provided short code. + + +## Contributing + +Contributions are always welcome! + + + +## License + +[MIT](https://choosealicense.com/licenses/mit/)