<p align="center"; style="font-size:115%;">This project helps user to generate a short URL making it easy to share and use.
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.
**Client:** [![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)](https://reactjs.org]) ![CSS Modules](https://img.shields.io/badge/CSS%20Modules-000000?style=for-the-badge&logo=CSS-Module&logoColor=white)
**Server:** [![Express](https://img.shields.io/badge/Express%20Js-yellow?style=for-the-badge&logo=expressJS)](https://expressjs.com/) [![Mongo](https://img.shields.io/badge/MongoDB-success?style=for-the-badge&logo=mongodb&logoColor=white&style=flat)](https://www.mongodb.com/)
To set up the project locally, follow these simple steps below:
Should have Node.js installed to get yarn package.
git clone https://github.com/webdev-20/shorti-url-shortener.git
cd shorti-url-shortener
yarn install
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
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
See contributing.md for ways to get started and more details.
Details of API endpoints can be viewed here https://localhost:4002/api/docs
openAPI
file for swaggercd server
npx swagger-jsdoc -d docs/definition.yaml src/routes/*.route.js "docs/*.yaml" -o docs/schemas/openapi.json
Visit the open issues for a full list of proposed features.
Visit our production site here - https://shorti.onrender.com/
Cheryl M
Discord ID- Notcori#0144
Project Link: https://github.com/webdev-20/shorti-url-shortener