Find a file
2025-02-21 02:05:01 +01:00
.github/workflows Added github workflow 2025-02-21 02:05:01 +01:00
static Initial commit 2025-02-21 01:23:57 +01:00
template Initial commit 2025-02-21 01:23:57 +01:00
.dockerignore Initial commit 2025-02-21 01:23:57 +01:00
.env.example Initial commit 2025-02-21 01:23:57 +01:00
.gitignore Initial commit 2025-02-21 01:23:57 +01:00
docker-compose.yml Initial commit 2025-02-21 01:23:57 +01:00
Dockerfile Removed automatic system install from Dockerfile 2025-02-21 00:44:56 +00:00
README.md Initial commit 2025-02-21 01:23:57 +01:00
requirements.txt Initial commit 2025-02-21 01:23:57 +01:00
server.py Fixed registration 2025-02-21 01:59:29 +01:00

uLinkShortener

This project is the code behind u.marcus7i.net, a custom URL shortener. It uses Flask, MongoDB, and Docker for quick deployment.

Prerequisites

  • Python
  • MongoDB database (local or remote)
  • Docker & Docker Compose (optional, for containerized deployments)

Setup

  1. Clone the repository
  2. Create a virtual environment (optional):
    python -m venv env
    source env/bin/activate  # Linux/Mac
    env\Scripts\activate     # Windows
    
  3. Install dependencies:
    pip install -r requirements.txt
    
  4. Define environment variables in the .env file:
    MONGO_URI=mongodb://<username>:<password>@<host>:<port>/<database>
    

Running Locally

  1. Start MongoDB
  2. Run:
    python server.py
    
  3. Access the app at http://localhost:5000

Docker Deployment

  1. Build and run containers:
    docker-compose up --build
    
  2. The application will be available at http://localhost:5000