Short description of the project

• 📖 Motivation
• 📦 Installation
• 🚀 Usage
• 🤝 Contributing
• 📝 License

$$\color{#00BFFF}Purpose$$

In order to easily create a new project, I have created a standard template for all my projects.

$$\color{#00BFFF}Features \space \color{#56565E}Included$$

• Issue templates
• Pull request templates
• Contributing guidelines
• Code of conduct
• Required resources to help people start contributing
• README.md file with a basic setup

$$\color{#00BFFF}Quick \space \color{#56565E}Start$$

Simply search and replace repo-template with the name of your project.

Or, use the automation script:

python assets/replace-name.py

Don't forget to change the logo and the demo video in the README.md file!

$$\color{#00BFFF}Clone \space \color{#56565E}Repository$$

git clone https://github.com/svijayb/repo-template
cd repo-template

$$\color{#00BFFF}Install \space \color{#56565E}Prerequisites$$

This project uses uv for fast, reliable Python package management. Install it with:

pip install uv

$$\color{#00BFFF}Setup \space \color{#56565E}Environment$$

Create a virtual environment and install all requirements. Make sure to update the pyproject.toml file with your project name and description!

uv sync

Before we can run the script, let's make sure to setup environment variables.

cp .env.example .env

Then, update the .env file with the relevant values.

$$\color{#00BFFF}Launch \space \color{#56565E}Application$$

To launch the application, use:

uv run main.py

$$\color{#00BFFF}Project \space \color{#56565E}Demo$$

You can also find the demo video here.

$$\color{#00BFFF}How \space \color{#56565E}to \space Contribute$$

To contribute to repo-template, fork the repository, create a new branch and send us a pull request. Make sure you read CONTRIBUTING.md before sending us Pull requests.

Thanks for contributing to Open-source! ❤️

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

██╗    ██╗███████╗    ██╗      ██████╗ ██╗   ██╗███████╗      ██╗██████╗                 
██║    ██║██╔════╝    ██║     ██╔═══██╗██║   ██║██╔════╝     ██╔╝╚════██╗                
██║ █╗ ██║█████╗      ██║     ██║   ██║██║   ██║█████╗      ██╔╝  █████╔╝                
██║███╗██║██╔══╝      ██║     ██║   ██║╚██╗ ██╔╝██╔══╝      ╚██╗  ╚═══██╗                
╚███╔███╔╝███████╗    ███████╗╚██████╔╝ ╚████╔╝ ███████╗     ╚██╗██████╔╝                
 ╚══╝╚══╝ ╚══════╝    ╚══════╝ ╚═════╝   ╚═══╝  ╚══════╝      ╚═╝╚═════╝                 
                                                                                         
 ██████╗ ██████╗ ███████╗███╗   ██╗    ███████╗ ██████╗ ██╗   ██╗██████╗  ██████╗███████╗
██╔═══██╗██╔══██╗██╔════╝████╗  ██║    ██╔════╝██╔═══██╗██║   ██║██╔══██╗██╔════╝██╔════╝
██║   ██║██████╔╝█████╗  ██╔██╗ ██║    ███████╗██║   ██║██║   ██║██████╔╝██║     █████╗  
██║   ██║██╔═══╝ ██╔══╝  ██║╚██╗██║    ╚════██║██║   ██║██║   ██║██╔══██╗██║     ██╔══╝  
╚██████╔╝██║     ███████╗██║ ╚████║    ███████║╚██████╔╝╚██████╔╝██║  ██║╚██████╗███████╗
 ╚═════╝ ╚═╝     ╚══════╝╚═╝  ╚═══╝    ╚══════╝ ╚═════╝  ╚═════╝ ╚═╝  ╚═╝ ╚═════╝╚══════╝