README

Open Source Issue Tracker

A lightweight, self-hosted issue tracking system built with Python and SQLite. Ideal for small teams or individual developers managing open-source projects.

๐Ÿš€ Features

  • Issue Management: Create, update, and delete issues with ease.
  • SQLite Backend: Stores data locally in a lightweight SQLite database.
  • Web Interface: Simple and intuitive web UI for managing issues.
  • Minimal Dependencies: Built with Python and minimal external libraries.

๐Ÿ› ๏ธ Installation

Prerequisites

  • Python 3.8+
  • pip (Python package installer)

Steps

  1. Clone the Repository

    git clone https://github.com/rudrasheth/opensource-issue-tracker.git
    cd opensource-issue-tracker
    
  2. Set Up a Virtual Environment

    python -m venv venv
    source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
    
  3. Install Dependencies

    pip install -r requirements.txt
    
  4. Run the Application

    python app.py
    

    The application will start on http://127.0.0.1:5000.

๐Ÿ“‚ Project Structure

opensource-issue-tracker/
โ”œโ”€โ”€ app.py             # Main application file
โ”œโ”€โ”€ database.py        # Database setup and models
โ”œโ”€โ”€ issues.db          # SQLite database file
โ”œโ”€โ”€ requirements.txt   # Python dependencies
โ””โ”€โ”€ templates/         # HTML templates for the web interface

๐Ÿงช Testing

To run tests, ensure you have the required dependencies installed and then execute:

pytest

๐Ÿค Contributing

We welcome contributions! To get started:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-name).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add new feature').
  5. Push to the branch (git push origin feature-name).
  6. Create a new Pull Request.

Please ensure your code adheres to the existing style and includes appropriate tests.

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


Feel free to customize this template further based on any additional features or specifics of your project.