Skip to content

Anksus/shortly

Repository files navigation


Shortly

Web service to convert long URLs to short one.

View Demo · Report Bug · Request Feature

About The Project

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Installation

  1. Clone the repo
    git clone https://github.com/Anksus/shortly
  2. Install NPM packages
    npm install
  3. Create env file for credentials in the root folder.
    touch .env.local
  4. Paste all the required credentials in .env file
    MONGODB_URI=SOME_SECRET
    GOOGLE_ID=SOME_SECRET
    GOOGLE_SECRET=SOME_SECRET
    NEXTAUTH_URL=http://localhost:3000/
  5. Run it
    npm run dev

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.