https://github.com/opencodechicago/hacktoberfest-2025-backend
Backend app for Open Code Chicago’s Hacktoberfest 2025 — open-source contributions welcome!
https://github.com/opencodechicago/hacktoberfest-2025-backend
backend community hacktoberfest hacktoberfest2025 open-source opencodechicago
Last synced: 6 days ago
JSON representation
Backend app for Open Code Chicago’s Hacktoberfest 2025 — open-source contributions welcome!
- Host: GitHub
- URL: https://github.com/opencodechicago/hacktoberfest-2025-backend
- Owner: OpenCodeChicago
- License: mit
- Created: 2025-09-11T21:34:28.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-09-11T21:49:46.000Z (11 months ago)
- Last Synced: 2025-09-11T22:30:00.614Z (11 months ago)
- Topics: backend, community, hacktoberfest, hacktoberfest2025, open-source, opencodechicago
- Language: Shell
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Hacktoberfest 2025 – Backend
[](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/commits/main)
[](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/actions/workflows/ci.yml)
[](LICENSE)
[](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/issues)
[](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/pulls)
[](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/graphs/contributors)
[](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/stargazers)
---
## Welcome Hacktoberfest Contributors!
This repo is part of [Open Code Chicago](https://opencodechicago.org)’s Hacktoberfest 2025 initiative.
Whether it’s your **first pull request** or your **50th**, you are welcome here!
Contribute to real-world open source code, learn backend development, and collaborate with a global community.
### ⭐ Support the Project!
If you like this project, please consider giving it a ⭐ on GitHub!
More stars help us reach a wider audience, attract new contributors, and make your contributions even more visible and valuable for your portfolio or employer.
Thank you for helping our open source community grow!
---
## Table of Contents
- [Description](#description)
- [Who is this for?](#who-is-this-for)
- [Tech Stack](#tech-stack)
- [Quick Start](#quick-start)
- [Features](#features)
- [Project Structure](#project-structure)
- [Running Tests](#running-tests)
- [Contributing](#contributing)
- [Hacktoberfest Contribution Guide](#hacktoberfest-contribution-guide)
- [Documentation](#documentation)
- [Contributors](#contributors)
- [License](#license)
- [Feedback](#feedback)
- [Support](#support)
- [Connect with us](#connect-with-us)
---
## Description
This is the **backend project** for Hacktoberfest 2025.
It’s built with **Node.js, Express.js, and MongoDB**, and set up for **easy contributions, testing, and collaboration**.
New contributors can help with APIs, database models, and documentation.
---
## Who is this for?
- Beginners making their **first open source contribution**
- Intermediate devs learning **Node.js, Express.js, REST APIs**
- Experienced contributors who want to **mentor others**
---
## Tech Stack
- **Node.js** – runtime
- **Express.js** – server framework
- **ESLint + Prettier** – linting & formatting
- **Jest / Supertest** – (optional) testing
- **GitHub Actions** – CI/CD pipelines
---
## Quick Start
See the [Usage Guide](docs/usage.md) for full setup.
```bash
# Clone the repo
git clone https://github.com/OpenCodeChicago/hacktoberfest-2025-backend.git
cd hacktoberfest-2025-backend
```
```bash
# Install dependencies
npm install
```
```bash
# Start dev server
npm run dev
```
---
## Local Development Setup
To work on this project locally, follow these steps:
1. **Set up your own MongoDB database**
- You can use [MongoDB Atlas](https://www.mongodb.com/atlas/database) (free tier) or run MongoDB locally.
2. **Copy environment variables**
- Copy `.env.example` to `.env`:
```bash
cp .env.example .env
```
- Fill in your own values for `MONGODB_URI` and other variables in `.env`.
3. **Seed the database**
- Run the seed script to populate your local database with sample data:
```bash
npm run seed
```
4. **Start the development server**
- Run:
```bash
npm run dev
```
5. **Lint your code before committing**
- Run:
```bash
npm run lint
```
6. **Ready to contribute!**
- Pick an issue, create a branch, and start coding.
---
## Features
- Simple **Express.js backend** ready to extend
- Developer-friendly setup
- Preconfigured **linting & formatting**
- GitHub Actions for **CI/CD**
- Open for **community collaboration**
---
## Project Structure
```bash
hacktoberfest-2025-backend/
├── .github/ # Workflows, templates, CODEOWNERS
│ ├── ISSUE_TEMPLATE/
│ ├── workflows/
│ └── ...
├── docs/ # Usage guide, FAQ
├── src/ # Backend source code
│ ├── server.js # Server entry
│ └── routes/ # Example routes
├── .eslintrc # ESLint config
├── .prettierrc # Prettier config
├── CONTRIBUTING.md # How to contribute
├── CODE_OF_CONDUCT.md # Code of conduct
├── SECURITY.md # Security policy
├── LICENSE # MIT License
└── README.md # This file
```
---
## Running Tests
This project uses [Jest](https://jestjs.io/) for unit testing.
### Run all tests
```bash
npm test
```
### Run a single test file
```bash
npx jest __tests__/utils.test.js
```
### Notes
1. Tests currently cover models, controllers, and utility functions.
2. You can add your own test files in the **tests** folder following the same structure.
3. Jest uses mongodb-memory-server for in-memory database testing, so you do not need to have a real MongoDB instance running for tests.
---
## Contributing
We welcome contributions from **everyone**!
Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started.
---
## Hacktoberfest Contribution Guide
1. Fork this repository
2. Check our [Project Board](https://github.com/orgs/OpenCodeChicago/projects/2)
- Look for an issue you’d like to work on
- Comment on the issue to let others know you’re taking it
- Maintainers may assign you to it (to avoid duplicates)
3. Create a new branch:
```bash
git checkout -b my-new-feature
```
4. Set up your local environment (see above)
- Make sure your `.env` is configured and your database is seeded
5. Make your changes (small, clear commits)
6. Run `npm run lint` before pushing
7. Open a Pull Request
- All PRs are automatically checked for linting in CI
- Tip: Start with [Good First Issues](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/labels/good%20first%20issue)
---
## Documentation
- [Usage Guide](docs/usage.md)
- [FAQ](docs/faq.md)
- [Contributing Guidelines](CONTRIBUTING.md)
- [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md)
- [Code Owners](.github/CODEOWNERS)
- [Issue Templates](.github/ISSUE_TEMPLATE/)
---
## Contributors
Thanks goes to these wonderful people:
Alex Smagin
💻 📖 🚧 📆
Kaushik KS
💻
Usama Ahmed
💻
Deepesh Dey
💻
mbm08
💻
shiv7shukla
💻
Dikamjit Borah
💻
Sharanya Pillai
💻 📖
Andy
💻
Iryna
💻
Nikhil Rajpurohit
💻
This project follows the [all-contributors](https://allcontributors.org) specification.
> Want to be listed here? [See how to add yourself!](./CONTRIBUTING.md#get-recognized-with-the-all-contributors-bot)
Contributions of any kind welcome!
---
## License
This project is licensed under the [MIT License](LICENSE).
---
## Feedback
We welcome feedback and suggestions to improve the template’s functionality and usability.
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).
---
## Support
📧 Contact: [info@opencodechicago.org](mailto:info@opencodechicago.org)
---
## Languages and Tools
---
## Connect with us
