Welcome to the Eventure branch of the project! This document outlines the key development practices and workflow standards to ensure maintainability, deployment success, and ease of collaboration.
Eventure is a redesigned, accessibility-focused event platform built using Next.js, Firebase, and standard CSS with Framer Motion. This branch represents a clean rebuild with a scalable and component-based architecture, prioritising performance, user experience, and inclusive design.
The direction of the platform is guided by the Eventure Product Roadmap, which outlines current milestones, future features, and areas for external collaboration (e.g., cybersecurity, analytics). It serves as a foundational reference for new contributors and strategic planning.
The visual direction and user experience of Eventure are informed by the official Figma design prototype, which serves as a central reference for layout, styling, and interactive behaviour.
We highly encourage contributors to propose new ideas, highlight opportunities for improvement, and suggest design or architectural changes. Innovation is welcome — as long as changes are made transparently and discussed with relevant team members beforehand. A shared understanding and agreement help maintain consistency and avoid unnecessary rework or conflicts.
For any proposed design changes, please provide references or sources of inspiration (e.g., Dribbble, Awwwards, well-designed existing platforms). This helps ground design choices in proven patterns, maintains visual cohesion, and allows meaningful discussion during reviews.
🧰 Tech Stack This branch of the platform is built using:
- Next.js – Framework for React with SSR and API routes
- Firebase – Backend services (Auth, Firestore)
- CSS Modules – Modular styling per component
- Framer Motion – Lightweight animations for UI feedback
Optional developer tools:
- VS Code with Prettier, ESLint extensions for consistent formatting and linting
- React Developer Tools for inspecting component hierarchies
🐞 Reporting Issues If you encounter bugs, inconsistencies, or areas for improvement:
- Open an Issue in the GitHub repository
- Describe the problem clearly (include screenshots/logs where helpful)
- Suggest possible fixes or tag it for team discussion This helps track concerns transparently and ensures nothing is lost in DMs or passing comments.
To maintain stability and ensure production deploys cleanly to Vercel, please follow this process:
restructure branch to be ActivityList/Eventure-main and not ActivityList/Eventure-main/activitylist when possible
git clone https://github.com/Gopher-Industries/TheActivityList.git
cd ActivityList/eventure-main/activitylist
npm installAlways develop on a separate branch from Eventure-main.
git checkout -b feature/your-feature-nameUse the production build during development to catch deployment-breaking issues early:
npm run buildAvoid relying solely on npm run dev, as some errors only appear during production compilation (which is what Vercel uses for deployment).
git add .
git commit -m "Add: [your meaningful message]"
git push origin feature/your-feature-nameOnce your feature branch is ready, submit a pull request (PR) to merge into Eventure-main. Before requesting a review, make sure:
✅ npm run build compiles successfully with no errors
✅ Code follows existing patterns and is modular and maintainable
✅ UI/UX aligns with the platform’s design principles
✅ No mock/test data is left in the codebase
✅ All relevant files are committed and pushed
🔁 Pull Request Requirements:
- Describe clearly what has been implemented or changed.
- Include screenshots or screen recordings where applicable (especially for visual/UI updates or new features).
- Note any limitations, edge cases, or follow-up work required.
- Tag relevant team members for review and include related issue/ticket references if available.
Well-documented PRs significantly speed up the review process and reduce misunderstandings.
All PRs must be reviewed and approved before merging. Reviewers will evaluate:
- 🧱 Code structure, modularity, and scalability
- ♿ Accessibility and responsiveness
- ✍️ Code readability and adherence to project standards
- 🎯 Functional accuracy and user experience consistency
✅ Only merge your PR after it’s approved and npm run build completes with no errors.
🔍 Additional Notes
- Avoid using hardcoded or mock data in production code. Use Firebase or structured temporary data responsibly.
- Keep component logic focused and decoupled from UI where possible.
- Accessibility is a priority: include keyboard navigation, proper semantic markup, ARIA roles, and sufficient color contrast.
📌 Future Considerations This README will evolve over time. Potential additions include:
- Detailed Firebase usage guide
- Design tokens and theme system
- Testing strategy
- Deployment checklist
🔮 For future feature planning and technical direction, please refer to the 📄 View the Product Roadmap
Thanks for contributing to Eventure. Let’s keep things clean, scalable, and accessible ✨