DEV Community

Rushikesh Pundkar
Rushikesh Pundkar

Posted on

Food distribution portal

Hacktoberfest: Maintainer Spotlight

πŸŽƒ Hacktoberfest Challenge: Food-Distribution-Portal- 🍽️

Repository: rushikesh648/Food-distribution-portal-
https://github.com/rushikesh648/Food-distribution-portal-
Project Goal: To create a web portal that facilitates the distribution of food, connecting donors/organizations with those in need.

The Challenge: Boost Developer Experience and Project Setup

The current portal needs foundational contributions to make it easier for future developers to join and contribute. Your challenge is to improve the documentation, code quality, or development workflow.

Choose one (or more!) of the following tasks to complete:

1. πŸ“ Documentation Master (Highest Priority)

The project currently lacks a detailed description. Create a comprehensive README.md file that includes:

  • A brief, engaging Project Description.
  • A list of Technologies Used (e.g., JavaScript, React/JSX).
  • Clear Installation/Setup Instructions (How to clone, install dependencies, and run the project locally).
  • A Contributing Guide (simple steps on how to submit a PR).

2. ✨ Code Quality Guardian

Help enforce a consistent coding style across the project's JavaScript/JSX files:

  • Set up Prettier to handle code formatting automatically.
  • Set up ESLint with a modern configuration (e.g., Airbnb or Standard config) to catch common errors and ensure best practices.
  • (Bonus) Add a lint script to package.json and fix any existing style issues across the codebase.

3. πŸ§ͺ First Feature Test

The repository contains an App_test.js file, suggesting the intent for testing exists.

  • Set up a Testing Framework (e.g., Jest and React Testing Library).
  • Write and successfully run a single unit test for one of the existing components (e.g., App.js or Internal-dash-compo.jsx). This test should confirm that a component renders without crashing.

How to Participate:

  1. Fork the repository: https://github.com/rushikesh648/Food-distribution-portal-
  2. Create a new branch for your feature/fix.
  3. Commit your changes and make sure they meet the challenge criteria.
  4. Submit a Pull Request (PR) and mention the task you completed (e.g., "Feat: Add comprehensive README.md" or "Chore: Setup ESLint and Prettier").

Happy Hacking!

Top comments (0)