This project is archived (since 10/2024).
Reason
- There are professional event platforms (like Eventbrite and MeetUp) which now provide their service without any charges if your event has no ticket costs/is free. This seems to be a really nice offer.
- Self-hosting an event platform (server, database, mail etc.) takes some money per month as well as ongoing effort for operations and maintenance. This might be to much costs for small non-profit organizations.
Nevertheless feel free to fork an continue this project. :)
Chapter 2 – event management tool
Chapter 2 is an event management tool for non-profit organizations. It's open-source, free and easy to use. 💫
The goal of this project is to provide a self-hosted Docker container deployed to the cloud with a one-click and then configured by the owner. No coding required.
Your organization can host an own instance of Chapter 2 under a sub-domain of your website, such as chapter.sierraclub.org or chapter.womenwhocode.org. All of an organization's user data will remain under their control.
See our Vision statement. (by freeCodeCamp)
(Chapter 2 continues the deprecated project freeCodeCamp/chapter.)
Features
Attend and Subscribe to Events
- View events – See upcoming and past events of the organization and chapters.
- Attend events – Members can attend events. Attendance to invite-only events needs confirmation by event organizers.
- Waiting list – If an events capacity is reached, members will be placed on a waiting list.
- Subscribe to notifications – Members can subscribe to event notifications, to get notified on new, changed and canceled events.
Maintain Events
- Create events – Create events and assign them to chapters. Maintain information per event - such as name, description, start/end date, image, capacity, online/offline, public/invite-only.
- Event report – See reports of events and attendees per chapter.
Manage Organization and Chapters
- Create chapters – Manage your organizational structure by creating chapters (like sub-organizations or local branches of an organization).
- Chapter overview – See all chapters and relating events.
- Join/leave chapters – Members are able to join and leave chapters.
- Subscribe to chapters – Members can subscribe to chapters to get notified for new events.
Account Management
- Request and delete data – Users are able to request and download their account data, as well as delete their accounts.
- Manage users – Administrators can manage users of each chapter, set roles, ban and unban users.
Terminology
To better communicate and more easily build an API and UI, the current contributors have decided on a collection of terminology to clarify discussions surrounding the Chapter project:
| Term | Definition | Example |
|---|---|---|
| instance | a web server deployment of the Chapter application, managed by an organization. | a Docker container running on a web host |
| organization | the main structure with multiple chapters | Women Who Code at the sub-domain: chapter.womenwhocode.org |
| chapter | a organizational structure for events and users | Women Who Code - New York City |
| event | a meeting with a specific location and time to which users can attend | Coffee And Code - BistroOne, New York City, NY - April 9, 2020 |
| Roles | ||
| role | a definition of permissions to be attached to users for the purpose of granting authorization | Owner, Adminstrator, Organizer, Member |
| user | an authenticated person who is authorized based on their role(s) | Sally Gold - SallyG@example.com |
| visitor | an non-authenticated person with view-only access to public content | Any visitor |
| member | the role of a user who can follow and receive notifications from a chapter and attend events | Women Who Code - Edinburgh, Local Member |
| organizer (not available yet) |
the role of a user who can manage a chapter's events, attendees, communications, and members | Women Who Code - Edinburgh, Local Organizer |
| administrator | the role of a user who can setup and manage chapters and organizers for an organization | Women Who Code - European Administrator |
| owner | the role of a user who can configure the Chapter application instance and manage administrators for an entire organization | Women Who Code - Global IT |
Tech Stack
Backend
- Node.js + Express - webserver
- Apollo server - extendable graphql server
- type-graphql - code first graphql schema definition library
Frontend
- React + Next.js - client and server-side rendering of frontend
- Apollo Client 3 - access Apollo server
- Chakra UI - simple, modular & accessible UI component library for React
Database
Test
- Jest - for writing unit tests.
- Cypress - to check if specific actions are possible to perform in certain scenarios.
For more information and a guide to working on features, go to the contributing docs.
Roadmap
MVP (in progress)
The MVP user stories are shown in the MVP milestone and should be done first.
Post-MVP
There is a list of further project phases using Milestones.
Project Board
See the Project Board to find out what we are working on.
UI / UX / Design References
- Mockups (by freeCodeCamp)
- User Role Workflows (by freeCodeCamp)
- UI / UX Issues (by freeCodeCamp)
Contributing
-
Please read the contributing guidelines and steps needed to setup Chapter 2 locally. We take you from local setup to submitting pull requests.
-
Join our chat to get connected and follow announcements. (by freeCodeCamp)
License
Copyright (c) 2019-2024 freeCodeCamp, Hanneses
The computer software is licensed under the BSD-3-Clause license.
Contributors ✨
Thanks goes to these wonderful volunteers (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!