Short description of the project
In order to easily to create a new project, we decided to create a template for the all OSC projects. This template currently contains the following features:
- Issue templates.
- Pull request templates.
- Contributing guidelines.
- Code of conduct.
- Requires resources to help people start contributing.
- README.md file with a basic setup.
Simply search and replace OSC-Template with the name of your project.
Useful comments are added in the README.md file for better understanding.
For the latest stable version, head to Releases.
Download and extract the source code.
As an alternative, you could also clone the repository using,
git clone https://github.com/Open-Source-Community-VIT-AP/OSC-Template
Once you have the source code, create a virtual environment using the following command,
python3 -m venv venv
Enter the virtual environment and install dependancies using pip install -r requirements.txt.
To launch the file, use the following command, python3 app.py.
To contribute to OSC-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.
Also, thanks for contributing to Open-source!
OSC-Template is under The MIT License. Read the LICENSE file for more information.
