Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

63 lines (38 loc) · 1.11 KB

Project Mirage Contribution Guide

This file explains how to set-up and run the project locally

Prerequisites

  • Python 3.x installed
  • Pip package manager installed

Setup

  1. Navigate to project directory

    cd project-mirage
  2. Create a virtual environment (optional but recommended)

    python -m venv venv
  3. Activate the virtual environment (venv):

    • For Windows:

      venv\Scripts\activate
    • For Mac/Linux:

      source venv/bin/activate
  4. Installing dependencies

    pip install -r requirements.txt
    
    

Running the application

  1. Run the Flask application:

    python main.py

This will start the development server.

Open your web browser and go to http://127.0.0.1:5000/ to view the application.

Directory Structure

  • main.py: Flask application script.
  • utils/generate.py: Module containing the generate_random function.
  • static/styles/index.css: CSS styles for the HTML template.
  • templates/index.html: HTML template for the homepage.