View Demo · Report Bug · Request Feature

This project helps user to generate a short URL making it easy to share and use.

Table of Contents

• Table of Contents
• About The Project
• Built With
• Getting Started
  • Prerequisites:
  • Run project locally
• Contributing
• API Documentation
• Features
• Live Site
• License
• Contacts

About The Project

Users can shorten a link using this app which returns a short code that redirects to the original link.

Currently user account functions are in development phase.

(back to top)

Built With

Client:

Server:

(back to top)

Getting Started

To set up the project locally, follow these simple steps below:

Prerequisites:

Should have Node.js installed to get yarn package.

Run project locally

1. Fork and Clone the repository

  git clone https://github.com/webdev-20/shorti-url-shortener.git

2. Go to the project directory

  cd shorti-url-shortener

3. Install dependencies in both client and server

  yarn install

4. Start the server

  yarn start (for both client and server)
  yarn client (for client only)
  yarn server (for server only)

Note: Create and fill in server/.env and client/.env

More details here

(back to top)

Contributing

We welcome your contribution!

Please get the issue assigned to yourself before working on it, to avoid duplicate efforts.

Any Suggestions, please fork the repo and create a pull request. Or create an issue with tag - enhancement

1. Fork the repository
2. Clone it and navigate to your local repository
3. Create your feature branch, example:- fix/header
4. Stage changes & commit
5. Create a pull request

See contributing.md for ways to get started and more details.

(back to top)

API Documentation

Details of API endpoints can be viewed here https://localhost:4002/api/docs

Generate openAPI file for swagger

cd server

npx swagger-jsdoc -d docs/definition.yaml src/routes/*.route.js "docs/*.yaml" -o docs/schemas/openapi.json

Features

• Url Shortening
• Redirect to original Url using the short Url
• Show a list of previously shortened Url
  

Visit the open issues for a full list of proposed features.

Live Site

Visit our production site here - https://shorti.onrender.com/

(back to top)

License

MIT

Contacts

Cheryl M
Discord ID- Notcori#0144

Project Link: https://github.com/webdev-20/shorti-url-shortener

(back to top)