SoftwareProject

A modern web application built with Django 5.1 and Python 3.12.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Acknowledgments

About The Project

SoftwareProject is a modern web application built with Django 5.1 and Python 3.12. The project follows a clean, modular architecture designed for container-based deployment and automated workflows.

Here's why:

• Clean, modular architecture that makes development and maintenance straightforward
• Ultra-fast dependency management with uv, eliminating environment friction
• Fully automated CI/CD: from commit to production with no manual intervention

Of course, no single project will fit every need. If you have suggestions, fork the repo and create a Pull Request, or open an issue. Contributions are always welcome!

(back to top)

Built With

This section lists the major frameworks and technologies used in this project.

• 
• 
• 
• 
• 

(back to top)

Getting Started

Here is how to get a local copy up and running.

Prerequisites

Make sure you have uv installed for virtual environment and dependency management:

pip install uv

Or check the official uv documentation for other installation options.

Installation

Below are the steps to install and configure the application. It does not rely on any external services.

Option A — With UV (Recommended)

1. Clone the repository

   git clone https://github.com/TralaleritosTralalas/SoftwareProject.git
   cd SoftwareProject

2. Sync the virtual environment and dependencies

   uv sync

3. Run database migrations

   uv run python manage.py makemigrations
   uv run python manage.py migrate

4. Start the development server

   uv run python manage.py runserver

Option B — With Docker

docker-compose up --build

(back to top)

Usage

Once the server is running, open http://127.0.0.1:8000/ in your browser. The live production site is available at:

👉 https://softwareproject-web-latest.onrender.com/

You can also generate the repository issues analytics histogram by running:

cd IshikawaTools/
uv run python histogram.py

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Docker and Docker Compose setup
• CI/CD workflows with GitHub Actions
• Automatic deployment to Render
• Issues analytics script (histogram.py)
• Expanded test coverage
• Project documentation

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

Acknowledgments

Resources and tools that have been helpful in this project.

• uv — Python package manager
• Django Documentation
• Render — Cloud Hosting
• GitHub Actions Docs
• contrib.rocks
• Choose an Open Source License
• Img Shields

(back to top)