Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 853 Bytes

README.md

File metadata and controls

34 lines (23 loc) · 853 Bytes

Run in Postman

Click Short

URL shortner || Simplified click redirection and tracking

Development Setup:

  • Add firebase-credentials.json from firebase console for auth.
  • If you have already mongodb installed on your system, run it.
    OR
  • Run mongodb inside docker (Compose file is written here docker):
    • cd docker/mongodb
    • docker-compose up

Once Mongodb is up:

  • cd into root directory with cd ../..
  • Install packages with npm install
  • Start development with npm run start:dev

Recommendations:

  • Use Postman for checking the api requests
  • Use Robo3T tool as a mongodb gui

Contribution

  • Fork the branch
  • Make changes
  • run npm run format
  • Make a PR

Thanks for coming here!