|
| 1 | +# Welcome to ReactPlay for Hacktoberfest! |
| 2 | + |
| 3 | +Thank you for joining the ReactPlay open-source community during Hacktoberfest 2025! 🎉 |
| 4 | + |
| 5 | +ReactPlay is an open-source web app designed to help you learn ReactJS through hands-on projects. Whether you're here to learn, create, or contribute, your participation is valuable. |
| 6 | + |
| 7 | +## Important Points for Hacktoberfest Contributors |
| 8 | + |
| 9 | +- **How to Contribute** |
| 10 | + - Fork the `react-play` repository. |
| 11 | + - Clone your fork locally and set up the project for development. |
| 12 | + - Create or improve ReactJS projects called "Plays" and share your code. |
| 13 | + - Follow the [`CONTRIBUTING.md`](./CONTRIBUTING.md) for guidelines and the code review process. |
| 14 | + - Ensure your pull requests are meaningful, respectful, and adhere to coding standards. |
| 15 | + - Run linting and tests as described in the contribution guide before submitting your PR. |
| 16 | + |
| 17 | +- **Environment Setup** |
| 18 | + - Use Node.js version 16.x or higher. |
| 19 | + - Install dependencies using `yarn install` (recommended) or `npm install`. |
| 20 | + - Start the app locally with `yarn start` or `npm start` for live development. |
| 21 | + |
| 22 | +- **Code Quality** |
| 23 | + - The project runs ESLint and formatting checks automatically. |
| 24 | + - Fix any lint errors with `yarn run lint:fix` or `npm run lint:fix`. |
| 25 | + - Format your code using `yarn run format` or `npm run format`. |
| 26 | + - Pull requests with lint errors may not be reviewed or accepted. |
| 27 | + |
| 28 | +- **Getting Help** |
| 29 | + - Check the issues to find new feature requests or bugs to work on. |
| 30 | + - Ask questions or request help via GitHub issues or the ReactPlay community channels. |
| 31 | + - Read the official ReactPlay [docs](https://docs.reactplay.io) and Watch the [YouTube guide](https://www.youtube.com/watch?v=h8suY-Osn8Q) for repository management. |
| 32 | + |
| 33 | +- **Rewards and Recognition** |
| 34 | + - Your contributions will be recognized publicly and you can claim special ReactPlay badges. |
| 35 | + - Show your ReactPlay badges with pride to inspire others. |
| 36 | + |
| 37 | +## Quick Links |
| 38 | + |
| 39 | +- [ReactPlay Demo](https://reactplay.io) — Explore the app live |
| 40 | +- [Contribution Guide](./CONTRIBUTING.md) — Learn how to contribute the right way |
| 41 | +- [Code of Conduct](CODE_OF_CONDUCT.md) — Our community values |
| 42 | +- [Claim Your Hacktoberfest Reward Badge](https://aviyel.com/projects/43/reactplay/rewards) |
| 43 | + |
| 44 | +Let's learn, create, and grow together with ReactPlay! |
| 45 | + |
| 46 | +Happy Hacktoberfest and happy coding! |
| 47 | + |
| 48 | + |
0 commit comments