An open API service indexing awesome lists of open source software.

https://github.com/gthomas08/url-shortener-microservice

freeCodeCamp URL Shortener Microservice
https://github.com/gthomas08/url-shortener-microservice

express freecodecamp javascript mongodb nodejs

Last synced: 5 days ago
JSON representation

freeCodeCamp URL Shortener Microservice

Awesome Lists containing this project

README

        

# URL Shortener Microservice

[![Run on Repl.it](https://repl.it/badge/github/gthomas10/URL-Shortener-Microservice)](https://repl.it/github/gthomas10/URL-Shortener-Microservice)

## About The Project

This project is part of the FreeCodeCamp Back End Development and APIs curriculum.

You can find more information [here](https://www.freecodecamp.org/learn/back-end-development-and-apis/back-end-development-and-apis-projects/url-shortener-microservice).

### Built With

* [Node.js](https://nodejs.org)
* [Express](https://expressjs.com)
* [MongoDB](https://www.mongodb.com)

## Getting Started

### Prerequisites

* [Node.js](https://nodejs.org/)

### Installation

1. Clone the repo
```bash
git clone https://github.com/gthomas08/URL-Shortener-Microservice.git
```
2. Go to project directory
```bash
cd URL-Shortener-Microservice
```
3. Install npm packages
```bash
npm install
```
4. Add the following environment variable to .env file

`MONGO_URI`

## Usage

Start the application
```bash
npm start
```

Test that the project is running by going to http://localhost:8080.