Shortify is a simple URL shortener app and services built upon MEVN/VENoM stack. It will convert your boring long URL into nice and simple eight-character shorties (that I like to call those short generated urls π). Not to mention they are unique for every new URL. It also keeps the history of your recent conversions. One click to copy and off you go!
docker-compose up
in your terminal and access the UI in the browser @ localhost:8080
Go to the root directory and follow below steps -
For Client -
$ cd client
$ npm run serve
Access the UI in the browser @
localhost:8080
For Server -
$ cd server
$ npm run dev
Access the services @
localhost:8081
Endpoint | Service | |
---|---|---|
GET | /api | Retrieve all shorties |
POST | /api/create | Create a shorty |
DELETE | /api/delete/id | Delete a shorty |
DELETE | /api/deleteAll | Delete all shorties |
View or download the Shortify Open API Specification document.
- Vue.js
- TypeScript
- Express.js
- Mongoose
- MongoDB
- Docker
- Jest
-
Fork this repo. - Click the fork symbol on rightmost top corner of your window.
-
Visit https://github.com/sprakash57/shortify/issues and comment on the issue you want to work on.
-
Clone the forked repo. - Click the green button saying "Code" with a download button.
-
Test your changes thorughly. Put proper and meaningfull commit messages. Inline comments for complex logic, JSDoc and explanation for any external library is highly appreciated.
-
Create a Pull Request. Follow this guide https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github to know more.
-
Star β to the repo would be much appreciated.
https://www.atlassian.com/git/tutorials/making-a-pull-request.