- Description
- Who is this for?
- Tech Stack
- Quick Start
- Features
- Project Structure
- Contributing
- Documentation
- Contributors
- Security
- License
- Feedback
- Support
- Connect with us
This is the frontend template for Open Code Chicago’s Hacktoberfest 2025 project.
It’s designed for community collaboration and provides a structured way for developers of all levels to contribute.
- Beginners looking to make their first open source contribution
- Intermediate developers who want to learn React, Vite, and frontend best practices
- Experienced contributors mentoring and guiding others
- React (with Vite for fast dev/build)
- TypeScript (for type safety and scalability)
- ESLint + Prettier (code style and linting)
- GitHub Actions (CI/CD with tests and builds)
See the Usage Guide for detailed setup.
# Clone the repo
git clone https://github.com/OpenCodeChicago/hacktoberfest-2025-frontend.git
cd hacktoberfest-2025-frontend
# Install dependencies
npm install
# Start dev server
npm run dev
- Developer-friendly setup with Vite
- Preconfigured linting & formatting
- Ready-to-use GitHub Actions for CI/CD
- Community-driven with issues & PR templates
hacktoberfest-2025-frontend/ # Main project root
├── .github/ # GitHub configuration
│ ├── ISSUE_TEMPLATE/ # Predefined issue templates
│ │ ├── bug_report.md
│ │ └── feature_request.md
│ ├── workflow/ # GitHub Actions workflows
│ │ └── ci.yml
│ ├── CODEOWNERS # Defines code reviewers
│ ├── dependabot.yml # Automated dependency updates
│ └── PULL_REQUEST_TEMPLATE.md # Standard PR template
│
├── docs/ # Project documentation
│ ├── images/ # Images and assets for docs
│ ├── faq.md
│ └── usage.md
│
├── src/ # Application source code
│ ├── components/ # React components
│ └── main.js # Entry point
│
├── .all-contributorsrc # Config for all-contributors bot
├── .gitignore # Ignored files
├── .prettierrc # Code formatting config
├── CODE_OF_CONDUCT.md # Community standards
├── CONTRIBUTING.md # Contribution guidelines
├── LICENSE # License file
├── README.md # Project overview
├── SECURITY.md # Security policy
└── index.html # Main HTML file
We welcome contributions from everyone! Please see our Contributing Guidelines for details on how to get started.
Thanks goes to these wonderful people:
Alex Smagin 📖 🚇 🚧 📆 |
This project follows the all-contributors specification.
Contributions of any kind welcome!
This repository has the following security features enabled:
- Dependency Review Action – warns/block PRs introducing vulnerable or malicious packages
- OpenSSF Scorecard – weekly scans for open-source best practices and supply-chain risks
- Dependabot – automated dependency updates
For details, see our Security Policy.
This project is licensed under the MIT License.
We welcome feedback and suggestions to improve the template’s functionality and usability.
Feel free to open an issue or start a discussion.
📧 Contact: [email protected]