Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gahbr/url-shortener
URL shortener microservice in NodeJS - ExpressJS - MongoDB
https://github.com/gahbr/url-shortener
api express heroku mongodb mongoose node nodejs url-shortener
Last synced: 8 days ago
JSON representation
URL shortener microservice in NodeJS - ExpressJS - MongoDB
- Host: GitHub
- URL: https://github.com/gahbr/url-shortener
- Owner: Gahbr
- Created: 2022-08-31T22:19:31.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-09-20T20:56:55.000Z (about 2 years ago)
- Last Synced: 2023-03-05T07:37:41.584Z (over 1 year ago)
- Topics: api, express, heroku, mongodb, mongoose, node, nodejs, url-shortener
- Language: JavaScript
- Homepage: https://shorten.up.railway.app/
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Status: Finished
About •
Layout •
User Stories •
Pre-requisites •
Tech Stack
## About
A Nodejs Microservice that shortens URL's. This project was proposed as a challenge in freecodecamp's "Back End Development and APIs" course. Link : https://shortenmylink.herokuapp.com
---
## Layout
---
## User Stories
* The API endpoint is GET [project_url]/api/shorturl/
* You can POST a URL to /api/shorturl and get a JSON response with original_url and short_url properties.
Here's an example: {original_url:'https://freeCodeCamp.org', short_url : 1}
* When you visit /api/shorturl/, you will be redirected to the original URL.
* If you pass an invalid URL that doesn't follow the valid http://www.example.com format,
the JSON response will contain{ error: 'invalid url' }
---
### Pre-requisites
Before you begin, you will need to have the following tools installed on your machine:
[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/).
In addition, it is good to have an editor to work with the code like [VSCode] (https://code.visualstudio.com/)
#### Running the application (server)
```bash
# Clone this repository
$ git clone https://github.com/Gahbr/URL-Shortener
# Access the project folder cmd/terminal
$ cd URL-Shortener
# install the dependencies
$ npm install
# Run the application in development mode
$ npm run dev
# The server will start at port: 3000 - go to http://localhost:3000
```
---
## Tech Stack
The following tools were used in the construction of the project:
> See the file [package.json](https://github.com/Gahbr/URL-Shortener/blob/main/package.json)
#### [](https://github.com/Gahbr/URL-Shortener)**Server**
- **[Nodejs](https://nodejs.org/)**
- **[Express](https://expressjs.com/)**
- **[MongoDB](https://mongodb.com)**
- **[CORS](https://expressjs.com/en/resources/middleware/cors.html)**
- **[dotENV](https://github.com/motdotla/dotenv)**
- **[Mongoose](https://mongodb.com/)**
- **[Valid URL](https://www.npmjs.com/package/valid-url)**
- **[BodyParser](https://www.npmjs.com/package/body-parser)**
---