Skip to content

Commit d6ad3be

Browse files
Alexandrbig1Alexandrbig1
authored
Revise README for Hacktoberfest 2025 backend
1 parent 7f92c7d commit d6ad3be

1 file changed

Lines changed: 100 additions & 92 deletions

File tree

‎README.md‎

Lines changed: 100 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,141 @@
1-
# Project Template
1+
# Hacktoberfest 2025 – Backend
22

33
<img align="right" src="https://media.giphy.com/media/du3J3cXyzhj75IOgvA/giphy.gif" width="100"/>
44

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)
5+
[![GitHub last commit](https://img.shields.io/github/last-commit/OpenCodeChicago/hacktoberfest-2025-backend)](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/commits/main)
6+
[![CI](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/actions/workflows/ci.yml/badge.svg?style=for-the-badge)](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/actions/workflows/ci.yml)
7+
[![License: MIT](https://img.shields.io/github/license/OpenCodeChicago/hacktoberfest-2025-backend)](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/blob/main/LICENSE)
8+
[![Open Issues](https://img.shields.io/github/issues/OpenCodeChicago/hacktoberfest-2025-backend)](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/issues)
9+
[![Pull Requests](https://img.shields.io/github/issues-pr/OpenCodeChicago/hacktoberfest-2025-backend)](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/pulls)
10+
[![Contributors](https://img.shields.io/github/contributors/OpenCodeChicago/hacktoberfest-2025-backend)](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/graphs/contributors)
11+
[![GitHub stars](https://img.shields.io/github/stars/OpenCodeChicago/hacktoberfest-2025-backend?style=for-the-badge)](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/stargazers)
12+
[![GitHub forks](https://img.shields.io/github/forks/OpenCodeChicago/hacktoberfest-2025-backend?style=for-the-badge)](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/network/members)
1613

1714
---
1815

1916
## 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)
17+
- [Description](#-description)
18+
- [Who is this for?](#-who-is-this-for)
19+
- [Tech Stack](#-tech-stack)
20+
- [Quick Start](#-quick-start)
21+
- [Features](#-features)
22+
- [Project Structure](#-project-structure)
23+
- [Contributing](#-contributing)
24+
- [Documentation](#-documentation)
25+
- [Contributors](#-contributors)
26+
- [License](#-license)
27+
- [Feedback](#-feedback)
28+
- [Support](#-support)
29+
- [Connect with us](#-connect-with-us)
3230

3331
---
3432

3533
## Description
3634

37-
A ready-to-use template repository for quickly starting new projects. Includes essential files, recommended structure, and documentation to streamline your workflow.
35+
This is the **backend template** for [Open Code Chicago](https://opencodechicago.org)’s Hacktoberfest 2025 project.
36+
It’s designed for **community collaboration** and provides a structured way for developers of all levels to contribute.
3837

3938
---
4039

4140
## Who is this for?
4241

43-
This template is designed for:
42+
- Beginners looking to make their **first open source contribution**
43+
- Intermediate developers who want to learn **Node js, Express js, and backend best practices**
44+
- Experienced contributors mentoring and guiding others
45+
46+
---
47+
48+
## Tech Stack
4449

45-
- **Open Code Chicago contributors** starting new community projects.
46-
- **Open source developers** who want a clean and consistent project structure.
50+
- **Node js** (with Vite for fast dev/build)
51+
- **Express js** (for type safety and scalability)
52+
- **ESLint + Prettier** (code style and linting)
53+
- **GitHub Actions** (CI/CD with tests and builds)
4754

4855
---
4956

5057
## Quick Start
5158

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.
59+
See the [Usage Guide](docs/usage.md) for detailed setup.
6360

64-
See [docs/setup.md](docs/setup.md) for more details.
61+
```bash
62+
# Clone the repo
63+
git clone https://github.com/OpenCodeChicago/hacktoberfest-2025-backend.git
64+
cd hacktoberfest-2025-backend
65+
```
66+
67+
```bash
68+
# Install dependencies
69+
npm install
70+
```
71+
72+
```bash
73+
# Start dev server
74+
npm run dev
75+
```
6576

6677
---
6778

6879
## Features
6980

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
81+
- Developer-friendly setup with Vite
82+
- Preconfigured linting & formatting
83+
- Ready-to-use GitHub Actions for CI/CD
84+
- Community-driven with **issues & PR templates**
7785

7886
---
7987

8088
## Project Structure
8189

82-
```bash
83-
project-template/ # GitHub project-template
84-
├── .github/
90+
.
91+
├── .github/ # Workflows, templates, CODEOWNERS
8592
│ ├── 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-
```
93+
│ ├── workflows/
94+
│ └── ...
95+
├── docs/ # Usage guide, FAQ
96+
├── src/ # React source code (main.jsx, components, etc.)
97+
├── .prettierrc # Prettier config
98+
├── CONTRIBUTING.md # How to contribute
99+
├── CODE_OF_CONDUCT.md # Code of conduct
100+
├── SECURITY.md # Security policy
101+
├── LICENSE # MIT License
102+
└── README.md # This file
112103

113104
---
114105

115106
## Contributing
116107

117-
We welcome contributions!
108+
We welcome contributions from everyone!
109+
Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started.
110+
111+
---
112+
113+
## Documentation
118114

119-
Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) before submitting pull requests.
115+
- [Usage Guide](docs/usage.md)
116+
- [FAQ](docs/faq.md)
117+
- [Contributing Guidelines](CONTRIBUTING.md)
118+
- [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md)
119+
- [Code Owners](.github/CODEOWNERS)
120+
- [Issue Templates](.github/ISSUE_TEMPLATE/)
121+
122+
---
123+
124+
## Contributors
125+
126+
Thanks goes to these wonderful people:
127+
128+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
129+
<!-- prettier-ignore-start -->
130+
<!-- markdownlint-disable -->
131+
132+
<!-- markdownlint-restore -->
133+
<!-- prettier-ignore-end -->
134+
135+
<!-- ALL-CONTRIBUTORS-LIST:END -->
136+
137+
This project follows the [all-contributors](https://allcontributors.org) specification.
138+
Contributions of any kind welcome!
120139

121140
---
122141

@@ -128,30 +147,19 @@ This project is licensed under the [MIT License](LICENSE).
128147

129148
## Feedback
130149

131-
We welcome feedback and suggestions to improve the template’s functionality and usability.
150+
We welcome feedback and suggestions to improve the template’s functionality and usability.
151+
Feel free to [open an issue](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/issues) or [start a discussion](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/discussions).
132152

133153
---
134154

135155
## Support
136156

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)
157+
📧 Contact: [info@opencodechicago.org](mailto:info@opencodechicago.org)
143158

144159
---
145160

146161
## Languages and Tools
147162

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-
155163
---
156164

157165
## Connect with us

0 commit comments

Comments
 (0)