Skip to content

Commit e6954f6

Browse files
docs: enhance README with contributors section, feature requests, and hackflow.org information
Co-Authored-By: Ja'dan Johnson <iamjadan@gmail.com>
1 parent 96b42a3 commit e6954f6

1 file changed

Lines changed: 86 additions & 16 deletions

File tree

README.md

Lines changed: 86 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
An open-source hackathon registration management platform focused exclusively on event registration functionality. Extracted from the full HackFlow platform to provide a streamlined, easy-to-deploy solution for hackathon organizers.
44

5-
## Features
5+
[![Deployed on HackFlow.org](https://img.shields.io/badge/Deployed%20on-HackFlow.org-blue)](https://hackflow.org)
6+
[![License](https://img.shields.io/badge/License-AGPL--3.0-green)](LICENSE)
7+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen)](CONTRIBUTING.md)
8+
9+
## 🌟 Features
610

711
### 🔐 Authentication System
812
- Organizer and applicant role-based authentication
@@ -33,7 +37,19 @@ An open-source hackathon registration management platform focused exclusively on
3337
- Application status management (pending, accepted, rejected, waitlisted)
3438
- Export functionality for applicant data
3539

36-
## Tech Stack
40+
## 🚀 Cloud Hosted Version
41+
42+
HackFlow Lite is available as a fully managed service at [HackFlow.org](https://hackflow.org). The cloud version includes:
43+
44+
- Managed infrastructure with automatic updates
45+
- Enhanced security features
46+
- Premium support options
47+
- Advanced analytics dashboard
48+
- Integration with additional HackFlow modules
49+
50+
Sign up for a free account at [HackFlow.org](https://hackflow.org) to get started immediately without any setup required.
51+
52+
## 🔧 Tech Stack
3753

3854
- **Frontend**: Next.js 15.3.3 with React 18 and TypeScript
3955
- **Styling**: Tailwind CSS with shadcn/ui components
@@ -42,7 +58,7 @@ An open-source hackathon registration management platform focused exclusively on
4258
- **Forms**: React Hook Form with Zod validation
4359
- **Deployment**: Vercel-compatible
4460

45-
## Quick Start
61+
## 🏁 Quick Start
4662

4763
### Prerequisites
4864

@@ -118,7 +134,7 @@ Open [http://localhost:3000](http://localhost:3000) to view the application.
118134
3. Fill in your details and select "Event Organizer" as your role
119135
4. Complete the registration process
120136

121-
## Database Schema
137+
## 📊 Database Schema
122138

123139
The application uses a simplified schema with four main tables:
124140

@@ -142,7 +158,7 @@ The application uses a simplified schema with four main tables:
142158
- Organizer and coordinator permissions
143159
- Multi-user event management
144160

145-
## Deployment
161+
## 🚢 Deployment
146162

147163
### Vercel Deployment
148164

@@ -165,7 +181,7 @@ The application uses a simplified schema with four main tables:
165181

166182
3. Configure your reverse proxy (nginx, Apache) to serve the application
167183

168-
## Development
184+
## 👨‍💻 Development
169185

170186
### Project Structure
171187

@@ -198,28 +214,80 @@ src/
198214
2. Add rendering logic in `src/components/dynamic-form-fields.tsx`
199215
3. Update the question builder in `src/components/registration-question-builder.tsx`
200216

201-
## Contributing
217+
## 👥 Contributors
218+
219+
HackFlow Lite is made possible by the contributions of these amazing people:
220+
221+
<table>
222+
<tr>
223+
<td align="center">
224+
<a href="https://github.com/jdanjohnson">
225+
<img src="https://github.com/jdanjohnson.png" width="100px;" alt="Ja'dan Johnson"/>
226+
<br />
227+
<sub><b>Ja'dan Johnson</b></sub>
228+
</a>
229+
<br />
230+
<sub>Project Lead</sub>
231+
</td>
232+
<td align="center">
233+
<a href="https://github.com/devin-ai-integration">
234+
<img src="https://avatars.githubusercontent.com/u/158848656?v=4" width="100px;" alt="Devin AI"/>
235+
<br />
236+
<sub><b>Devin AI</b></sub>
237+
</a>
238+
<br />
239+
<sub>Development</sub>
240+
</td>
241+
<!-- Add more contributors as needed -->
242+
</tr>
243+
</table>
244+
245+
### Become a Contributor
246+
247+
We welcome contributions from developers of all skill levels! See our [CONTRIBUTING.md](CONTRIBUTING.md) guide to get started.
248+
249+
## 🔄 Feature Requests & Feedback
202250

203-
1. Fork the repository
204-
2. Create a feature branch: `git checkout -b feature/new-feature`
205-
3. Make your changes and test thoroughly
206-
4. Commit your changes: `git commit -m 'Add new feature'`
207-
5. Push to the branch: `git push origin feature/new-feature`
208-
6. Submit a pull request
251+
We're constantly improving HackFlow Lite based on user feedback. Here's how you can help shape the future of the platform:
209252

210-
## License
253+
### Requesting New Features
254+
255+
1. Check the [Issues](../../issues) page to see if your feature has already been requested
256+
2. Use the "Feature Request" template to submit a new feature idea
257+
3. Be specific about the problem your feature would solve
258+
4. Consider including mockups or examples if applicable
259+
260+
### Providing Feedback
261+
262+
Your feedback is invaluable to us! Here are ways to share your thoughts:
263+
264+
- Create an issue with the "Feedback" label
265+
- Join our [Discord community](https://discord.gg/hackflow) for discussions
266+
- Email us at feedback@hackflow.org
267+
- Submit feedback directly through the HackFlow.org platform
268+
269+
### Voting on Features
270+
271+
We prioritize features based on community interest. You can:
272+
273+
- 👍 React to issues you'd like to see implemented
274+
- Comment with additional use cases or requirements
275+
- Help refine feature specifications through discussion
276+
277+
## 📜 License
211278

212279
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0) - see the [LICENSE](LICENSE) file for details.
213280

214-
## Support
281+
## 🆘 Support
215282

216283
For questions, issues, or contributions, please:
217284

218285
1. Check the [Issues](../../issues) page for existing problems
219286
2. Create a new issue with detailed information
220287
3. Follow the contributing guidelines for pull requests
288+
4. Visit [HackFlow.org/support](https://hackflow.org/support) for premium support options
221289

222-
## Roadmap
290+
## 🗺️ Roadmap
223291

224292
- [ ] Email notifications for application status updates
225293
- [ ] Advanced filtering and search for applicant management
@@ -231,3 +299,5 @@ For questions, issues, or contributions, please:
231299
---
232300

233301
**HackFlow Lite** - Streamlined hackathon registration management for the modern organizer.
302+
303+
[Website](https://hackflow.org) | [Documentation](https://docs.hackflow.org) | [Community](https://discord.gg/hackflow)

0 commit comments

Comments
 (0)