/link-shortener

Link Shortener is a web application that allows you enter any URL, shorten it and additionaly get stats if this link.

Primary LanguageTypeScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Link Shortener

Link Shortener is a web application that allows you enter any URL, shorten it and additionaly get stats if this link.

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

Product Name Screen Shot

(back to top)

Built With

  • Next
  • React
  • Prisma
  • TailwindCSS

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/borys35/link-shortener.git

  2. Install NPM packages

    npm install

  3. Enter your API in .env

     DATABASE_URL=
 NEXTAUTH_URL=
 NEXTAUTH_SECRET=

 GITHUB_ID=
 GITHUB_SECRET=

 GOOGLE_ID=
 GOOGLE_SECRET=

(back to top)

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

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

(back to top)

Contact

Borys Kaczmarek - boryskac10@gmail.com

Project Link: https://github.com/borys35/link-shortener

(back to top)

Acknowledgments

(back to top)