https://github.com/opencodechicago/project-template
A reusable template for Open Code Chicago projects — includes community standards, best practices, and starter structure.
https://github.com/opencodechicago/project-template
Last synced: 3 months ago
JSON representation
A reusable template for Open Code Chicago projects — includes community standards, best practices, and starter structure.
- Host: GitHub
- URL: https://github.com/opencodechicago/project-template
- Owner: OpenCodeChicago
- License: mit
- Created: 2025-09-03T15:39:49.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-09-03T15:51:01.000Z (4 months ago)
- Last Synced: 2025-09-03T17:35:36.524Z (4 months ago)
- Language: Dockerfile
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Project Template
[](https://github.com/OpenCodeChicago/project-template/commits/main)
[](https://github.com/OpenCodeChicago/project-template/actions/workflows/ci.yml)
[](https://github.com/OpenCodeChicago/project-template/blob/main/LICENSE)
[](https://github.com/OpenCodeChicago/project-template/issues)
[](https://github.com/OpenCodeChicago/project-template/pulls)
[](https://github.com/OpenCodeChicago/project-template/graphs/contributors)
[](https://github.com/OpenCodeChicago/project-template/stargazers)
[](https://github.com/OpenCodeChicago/project-template/network/members)
[](https://prettier.io/)
[](https://www.gnu.org/software/bash/)
[](Dockerfile)
---
## Table of Contents
- [Description](#description)
- [Who is this for?](#who-is-this-for)
- [Quick Start](#quick-start)
- [Features](#features)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
- [Feedback](#feedback)
- [Support](#support)
- [Languages and Tools](#languages-and-tools)
- [Connect with us](#connect-with-us)
---
## Description
A ready-to-use template repository for quickly starting new projects. Includes essential files, recommended structure, and documentation to streamline your workflow.
---
## Who is this for?
This template is designed for:
- **Open Code Chicago contributors** starting new community projects.
- **Open source developers** who want a clean and consistent project structure.
---
## Quick Start
1. Click the **"Use this template"** button on the repository page to create a new repo.
2. Clone your new repository:
```sh
git clone https://github.com/your-username/your-new-repo.git
cd your-new-repo
```
3. (Optional) Run the setup script:
```sh
bash setup.sh
```
4. Customize your project and update documentation as needed.
See [docs/setup.md](docs/setup.md) for more details.
---
## Features
- Pre-configured documentation folder (`docs/`)
- Example setup script (`setup.sh`)
- Dockerfile and .dockerignore for containerization
- Automated CI workflow with GitHub Actions (`.github/workflows/ci.yml`)
- Code of conduct and contributing guidelines
- Sample configuration files (`.editorconfig`, `.prettierrc`)
- Starter changelog
---
## Project Structure
```bash
project-template/ # GitHub project-template
├── .github/
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ └── feature_request.md
│ ├── workflow/
│ │ └── ci.yml
│ ├── CODEOWNERS
│ ├── dependabot.yml
│ └── PULL_REQUEST_TEMPLATE.md
│
├── docs/
│ ├── images/
│ ├── architecture.md
│ ├── faq.md
│ ├── setup.md
│ └── usage.md
│
├── .dockerignore
├── .gitignore
├── .prettierrc
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── README.md
└── setup.sh
```
---
## Contributing
We welcome contributions!
Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) before submitting pull requests.
---
## License
This project is licensed under the [MIT License](LICENSE).
---
## Feedback
We welcome feedback and suggestions to improve the template’s functionality and usability.
---
## Support
📧 Contact: [Email](mailto:info@opencodechicago.org).
If you find this template helpful, consider supporting us:
[](https://www.buymeacoffee.com/alexsmagin)
[](https://paypal.me/alexandrsmagin)
---
## Languages and Tools
---
## Connect with us
