Skip to content

Commit f49b4e8

Browse files
authored
Revise README with project details and badges
Updated README.md to enhance project description and add badges.
1 parent afe4ea0 commit f49b4e8

File tree

1 file changed

+173
-2
lines changed

1 file changed

+173
-2
lines changed

README.md

Lines changed: 173 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,173 @@
1-
# project-template
2-
A reusable template for Open Code Chicago projects — includes community standards, best practices, and starter structure.
1+
# Project Template
2+
3+
<img align="right" src="https://media.giphy.com/media/du3J3cXyzhj75IOgvA/giphy.gif" width="100"/>
4+
5+
[![GitHub last commit](https://img.shields.io/github/last-commit/OpenCodeChicago/project-template)](https://github.com/OpenCodeChicago/project-template/commits/main)
6+
[![CI](https://github.com/OpenCodeChicago/project-template/actions/workflows/ci.yml/badge.svg?style=for-the-badge)](https://github.com/OpenCodeChicago/project-template/actions/workflows/ci.yml)
7+
[![License: MIT](https://img.shields.io/github/license/OpenCodeChicago/project-template)](https://github.com/OpenCodeChicago/project-template/blob/main/LICENSE)
8+
[![Open Issues](https://img.shields.io/github/issues/OpenCodeChicago/project-template)](https://github.com/OpenCodeChicago/project-template/issues)
9+
[![Pull Requests](https://img.shields.io/github/issues-pr/OpenCodeChicago/project-template)](https://github.com/OpenCodeChicago/project-template/pulls)
10+
[![Contributors](https://img.shields.io/github/contributors/OpenCodeChicago/project-template)](https://github.com/OpenCodeChicago/project-template/graphs/contributors)
11+
[![GitHub stars](https://img.shields.io/github/stars/OpenCodeChicago/project-template?style=for-the-badge)](https://github.com/OpenCodeChicago/project-template/stargazers)
12+
[![GitHub forks](https://img.shields.io/github/forks/OpenCodeChicago/project-template?style=for-the-badge)](https://github.com/OpenCodeChicago/project-template/network/members)
13+
[![Prettier](https://img.shields.io/badge/prettier-2.8.8-ff69b4.svg?style=for-the-badge&logo=prettier)](https://prettier.io/)
14+
[![Bash](https://img.shields.io/badge/bash-5.2-4EAA25?logo=gnubash&logoColor=white&style=for-the-badge)](https://www.gnu.org/software/bash/)
15+
[![Docker](https://img.shields.io/badge/Docker-24.0-blue?logo=docker&style=for-the-badge)](Dockerfile)
16+
17+
---
18+
19+
## Table of Contents
20+
21+
- [Description](#description)
22+
- [Who is this for?](#who-is-this-for)
23+
- [Quick Start](#quick-start)
24+
- [Features](#features)
25+
- [Project Structure](#project-structure)
26+
- [Contributing](#contributing)
27+
- [License](#license)
28+
- [Feedback](#feedback)
29+
- [Support](#support)
30+
- [Languages and Tools](#languages-and-tools)
31+
- [Connect with us](#connect-with-us)
32+
33+
---
34+
35+
## Description
36+
37+
A ready-to-use template repository for quickly starting new projects. Includes essential files, recommended structure, and documentation to streamline your workflow.
38+
39+
---
40+
41+
## Who is this for?
42+
43+
This template is designed for:
44+
45+
- **Open Code Chicago contributors** starting new community projects.
46+
- **Open source developers** who want a clean and consistent project structure.
47+
48+
---
49+
50+
## Quick Start
51+
52+
1. Click the **"Use this template"** button on the repository page to create a new repo.
53+
2. Clone your new repository:
54+
```sh
55+
git clone https://github.com/your-username/your-new-repo.git
56+
cd your-new-repo
57+
```
58+
3. (Optional) Run the setup script:
59+
```sh
60+
bash setup.sh
61+
```
62+
4. Customize your project and update documentation as needed.
63+
64+
See [docs/setup.md](docs/setup.md) for more details.
65+
66+
---
67+
68+
## Features
69+
70+
- Pre-configured documentation folder (`docs/`)
71+
- Example setup script (`setup.sh`)
72+
- Dockerfile and .dockerignore for containerization
73+
- Automated CI workflow with GitHub Actions (`.github/workflows/ci.yml`)
74+
- Code of conduct and contributing guidelines
75+
- Sample configuration files (`.editorconfig`, `.prettierrc`)
76+
- Starter changelog
77+
78+
---
79+
80+
## Project Structure
81+
82+
```bash
83+
project-template/ # GitHub project-template
84+
├── .github/
85+
│ ├── ISSUE_TEMPLATE/
86+
│ │ ├── bug_report.md
87+
│ │ └── feature_request.md
88+
│ ├── workflow/
89+
│ │ └── ci.yml
90+
│ ├── CODEOWNERS
91+
│ ├── dependabot.yml
92+
│ └── PULL_REQUEST_TEMPLATE.md
93+
94+
├── docs/
95+
│ ├── images/
96+
│ ├── architecture.md
97+
│ ├── faq.md
98+
│ ├── setup.md
99+
│ └── usage.md
100+
101+
├── .dockerignore
102+
├── .gitignore
103+
├── .prettierrc
104+
├── CHANGELOG.md
105+
├── CODE_OF_CONDUCT.md
106+
├── CONTRIBUTING.md
107+
├── Dockerfile
108+
├── LICENSE
109+
├── README.md
110+
└── setup.sh
111+
```
112+
113+
---
114+
115+
## Contributing
116+
117+
We welcome contributions!
118+
119+
Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) before submitting pull requests.
120+
121+
---
122+
123+
## License
124+
125+
This project is licensed under the [MIT License](LICENSE).
126+
127+
---
128+
129+
## Feedback
130+
131+
We welcome feedback and suggestions to improve the template’s functionality and usability.
132+
133+
---
134+
135+
## Support
136+
137+
📧 Contact: [Email](mailto:info@opencodechicago.org).
138+
139+
If you find this template helpful, consider supporting us:
140+
141+
[![Buy Me a Coffee](https://img.shields.io/badge/buy%20me%20a%20coffee-yellow?logo=buy-me-a-coffee&style=for-the-badge)](https://www.buymeacoffee.com/alexsmagin)
142+
[![Donate via PayPal](https://img.shields.io/badge/paypal-donate-blue?logo=paypal&style=for-the-badge)](https://paypal.me/alexandrsmagin)
143+
144+
---
145+
146+
## Languages and Tools
147+
148+
<div align="center">
149+
<a href="https://git-scm.com/" target="_blank" rel="noreferrer">
150+
<img src="https://www.vectorlogo.zone/logos/git-scm/git-scm-icon.svg" alt="git" width="40" height="40"/></a>
151+
<a href="https://www.gnu.org/software/bash/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/gnu_bash-icon.svg" alt="Bash" height="50" /></a>
152+
<a href="https://www.docker.com/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/docker-original-wordmark.svg" alt="Docker" height="50" /></a>
153+
</div>
154+
155+
---
156+
157+
## Connect with us
158+
159+
<div align="center">
160+
<a href="https://www.youtube.com/@AlexSmaginDev" target="_blank">
161+
<img src="https://img.shields.io/badge/youtube-%23FF0000.svg?&style=for-the-badge&logo=youtube&logoColor=white" alt="YouTube" style="margin-bottom: 5px;" />
162+
</a>
163+
<a href="https://discord.gg/t6MGsCqdFX" target="_blank">
164+
<img src="https://img.shields.io/badge/discord-%237289DA.svg?&style=for-the-badge&logo=discord&logoColor=white" alt="Discord" style="margin-bottom: 5px;" />
165+
</a>
166+
<a href="https://www.linkedin.com/company/open-code-chicago" target="_blank">
167+
<img src=https://img.shields.io/badge/linkedin-%231E77B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white alt=linkedin style="margin-bottom: 5px;" />
168+
</a>
169+
<a href="https://www.facebook.com/profile.php?id=61580367112591" target="_blank">
170+
<img src="https://img.shields.io/badge/facebook-%231877F2.svg?&style=for-the-badge&logo=facebook&logoColor=white" alt="Facebook" style="margin-bottom: 5px;" />
171+
</a>
172+
173+
</div>

0 commit comments

Comments
 (0)