https://github.com/scottgriv/prg-bronze-tier-template
A repository template used for Bronze tier projects categorized under the PRG framework.
https://github.com/scottgriv/prg-bronze-tier-template
prg prg-framework prg-optimized prg-template readme readme-template template template-repo template-repository
Last synced: 2 months ago
JSON representation
A repository template used for Bronze tier projects categorized under the PRG framework.
- Host: GitHub
- URL: https://github.com/scottgriv/prg-bronze-tier-template
- Owner: scottgriv
- License: mit
- Created: 2023-11-20T20:53:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-20T00:51:41.000Z (3 months ago)
- Last Synced: 2025-03-28T18:32:31.511Z (2 months ago)
- Topics: prg, prg-framework, prg-optimized, prg-template, readme, readme-template, template, template-repo, template-repository
- Language: Markdown
- Homepage: https://prgoptimized.com
- Size: 851 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
---------------
PRG Bronze Tier Template
What is this Template for?
This Template is part of the
Personal Repository Guidelines (PRG)
repository categorization and guideline framework.
Visit the PRG Repository
to get started with PRG today.
Visit The Official PRG Website
for more information.
Submit a pull request to add your
PRG Portfolio to the PRG Showcase.
Looking for other Tier Templates?
You are here
> [!NOTE]
> I will be using examples from my project [River Charts](https://github.com/scottgriv/River-Charts) for this `README`.
- The description should be a short paragraph describing what your project is and what it does.
- This should be the first section after the badges.
- e.g. "A Python, Django, Plotly, and Pandas web application that visualizes river data pulled using an API from the United States Geological Survey (USGS)."
- Add **screenshots** of your project below the description and throughout the rest of the README as needed.
- This is optional, but highly recommended especially for **Gold** projects.
- Animations in the form of GIFs are also a great way to showcase your project.
> [!WARNING]
> Be sure to change the [PRG Connection File](PRG.md) **Repository Tier** parameter from **Optimized** to **Bronze** in order to correctly categorize this repository.
> All templates are currently set to the uncategorized "**Optimized**" option, so be sure to change this.
> [!WARNING]
> Be sure to change or remove the [.gitattributes](.gitattributes) file from this repository.
> It's used to classify this template repository as a Markdown file on GitHub only, and is not needed.
---------------
## Table of Contents
- [Getting Started](#getting-started)
- [Dependencies](#dependencies)
- [Configuration](#configuration)
- [Installation](#installation)
- [Deployment](#deployment)
- [Specific Project Sections](#specific-project-sections)
- [Resources](#resources)
- [License](#license)
-[MIT](#mit)
-[GNU](#gnu)
-[The Unlicense](#the-unlicense)
- [Credits](#credits)
## Getting Started
This section should contain a list of steps to get your project up and running.
- You can break this section down into further subsections if you want (such as below: Dependencies, Configuration, Running Locally, Deployment, etc.).
- Otherwise, you can just include a list of steps to get your project up and running under Getting Started.
### Dependencies
- This section should contain a list of dependencies for your project.
### Configuration
- This section should contain a list of steps to configure your project.
### Installation
- This section should contain a list of steps to install your project.
- Utilize code blocks to show the commands needed to run your project.
- e.g.
1. Clone this repository.
2. Create a virtual environment: `python -m venv venv`.
3. Install the dependencies.
4. Run the application:
```bash
python manage.py runserver
```
### Deployment
- This section should contain a list of steps to deploy your project.
## Specific Project Sections
There should be a number of sections here that correspond to important aspects of your project.
- Do not name this section "Specific Project Sections".
- e.g. "API", "Database", "Deployment", "Testing", etc.
## Resources
This section should contain a list of resources that you used to create your project.
Below are some external resources I found helpful when creating **My Project**:
- [Python](https://www.python.org/) - An interpreted, high-level and general-purpose programming language.
- [Plotly](https://plotly.com/python/) - A Python graphing library that makes interactive, publication-quality graphs online.
- [Django](https://www.djangoproject.com/) - A high-level Python Web framework that encourages rapid development and clean, pragmatic design.
- [Pandas](https://pandas.pydata.org/) - A fast, powerful, flexible and easy to use open source data analysis and manipulation tool, built on top of the Python programming language.
## License
This section should contain the license for your project. It should include a link to your actual license file inside your repository, and a link to [Choose an open source license](https://choosealicense.com) for reference.
> [!IMPORTANT]
> Use the [docs/LICENSE/](docs/LICENSE/) directory to pick amongst a few popular license files for your project.
> You can also visit [Choose an open source license](https://choosealicense.com) to pick your own that's not included with this template.
> If you don't include a `LICENSE` file, see what happens [here](https://choosealicense.com/no-permission/).
> For a zero restriction license, choose [The Unlicense](https://choosealicense.com/licenses/unlicense/).
> [!WARNING]
> Be sure to remove the [docs/LICENSE/](docs/LICENSE/) directory from this repository when you're done picking your license.
> Be sure to include your [LICENSE](LICENSE) file in the `root` of your repository and change the link below to point towards it.
*Examples:*
### MIT
This project is released under the terms of the **MIT License**, which permits use, modification, and distribution of the code, subject to the conditions outlined in the license.
- The [MIT License](https://choosealicense.com/licenses/mit/) provides certain freedoms while preserving rights of attribution to the original creators.
- For more details and to understand all requirements and conditions, see the [LICENSE](docs/LICENSE/MIT/LICENSE) file in this repository.
### GNU
This project is released under the terms of the **GNU General Public License, version 3 (GNU GPLv3)**, which ensures that derivatives of the software remain open source.
- The [GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/) is a "copyleft" license, ensuring that derivatives of the software remain open source and under the GPL.
- For more details and to understand all requirements and conditions, see the [LICENSE](docs/LICENSE/GNU/LICENSE) file in this repository.
### The Unlicense
This project is released under the terms of **The Unlicense**, which allows you to use, modify, and distribute the code as you see fit.
- [The Unlicense](https://choosealicense.com/licenses/unlicense/) removes traditional copyright restrictions, giving you the freedom to use the code in any way you choose.
- For more details and to understand all requirements and conditions, see the [LICENSE](docs/LICENSE/Unlicense/LICENSE) file in this repository.
## Credits
**Author:** [Scott Grivner](https://github.com/scottgriv)
**Email:** [[email protected]](mailto:[email protected])
**Website:** [scottgrivner.dev](https://www.scottgrivner.dev)
**Reference:** [Main Branch](https://github.com/scottgriv/PRG-Bronze-Tier-Template)
---------------