bensonybs / 2_3_s5_url_shortener

Short URL web app.

URL Shortener

Short URL web app.
This is a hands-on project of ALPHAcamp.

Getting start

Prerequisites

1. Node.js, v16.14.0
2. (Optional) nodemon (2.0.20)
3. MongoDB Atlas, sign up and get a free account

Install the app in local host

1. Clone this repo in local,
   git clone https://github.com/bensonybs/2_3_S5_URL_Shortener.git
2. Open terminal in the project directory, type npm install to install needed packages.
3. Sign in to MongoDB Atlas and get the URI. See the document of MongoDB for more information.
4. Save the URI to the environment variables on your computer(variable name: MONGODB_URI). Windows
5. On terminal, type npm run seed or node models/seeds/shortURLSeeder.js(without nodemon) to install seed data to your mongodb.
6. Type npm run dev or node app.js if you didn't install nodemon.
7. Go to http://localhost:3000 in the browser to see the website.

Demo

1. Input URL to create new short URL.
   If the URL you would like to shorten is already in the database, the stored short URL will show.
2. You can browse stored short URLs in 'Short URL List'.

Process Flow Chart

The app process flow chart is showed below.

Future Update

1. Let user add and edit short URL description.
2. User authentication.