Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.39 KB

README.md

File metadata and controls

75 lines (50 loc) · 2.39 KB

website Give me a star

Capy short

Another url shortener but open source and cool 😎

Capy - short is an open-source URL shortener project designed to simplify the process of creating and managing shortened URLs. This project aims to provide a lightweight, easy-to-use solution for individuals and organizations seeking to share concise and user-friendly links.

🌟 Features

  • Simple Interface: Capy - short offers a straightforward and user-friendly interface, making it easy for users to shorten URLs with just a few clicks.

  • Customizable Short URLs: Users can create custom short URLs to enhance brand visibility and maintain a consistent online presence.

  • Analytics: Gain insights into link performance with built-in analytics, tracking key metrics such as click-through rates and geographic location of visitors.

  • Open Source: Capy - short is an open-source project, encouraging collaboration and contributions from the community.

🚦 Getting Started

Follow these steps to get started with Capy - short:

  1. Clone the Repository:

    git clone https://github.com/romancitodev/capy-short
    
  2. Install Dependencies:

    cd capy-short
    pnpm install
    
  3. Configuration: use the .env.example file to configure your variables.

  4. Run the Application:

    pnpm run dev
    

Note

If you run for first time the app, generate the prisma client:

pnpm prisma generate
  1. Access the Application: Open your browser and navigate to http://localhost:3000 to access the Capy - short application.

License

Capy - short is licensed under the GNU License.

Support

For any questions or issues, please open an issue on the GitHub repository.

❤ made with love.