cizzors

command module
v0.0.0-...-f095a72 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 29, 2023 License: MIT Imports: 2 Imported by: 0

README

Cizzors

Cizzors

Cizzors is a URL shortening service developed as the capstone project for the AltSchool Africa School of Back End Engineering. The project aims to disrupt the URL shortening industry by providing a simple tool to shorten URLs and customize them for branding purposes. Additionally, Cizzors offers QR code generation and basic analytics for tracking link performance.

The live version of Cizzors API can be accessed at CIZZORS.

Running the App Locally using Docker

To run the Cizzors app locally using Docker, follow these steps:

  1. Ensure that Docker is installed on your system. You can download and install Docker from the official website: https://www.docker.com/get-started.

  2. Clone the Cizzors repository from GitHub using the following command:

    git clone https://github.com/your-username/cizzors.git

  3. Navigate to the cloned repository directory:

    cd cizzors

  4. Build the Docker image using the provided Dockerfile:

    docker build -t cizzors-app .

  5. Once the image is built successfully, you can run the Docker container:

    docker run -p 3001:3001 cizzors-app

The Cizzors app should now be running locally on port 3001. You can access it in your browser by visiting http://localhost:3001.

Please note that the above steps assume that you have cloned the Cizzors repository and have Docker installed on your machine. Adjust the commands accordingly based on your environment and repository configuration.

This project was developed as the capstone project for the AltSchool Africa School of Back End Engineering.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Code generated by swaggo/swag.
Code generated by swaggo/swag.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL