Event Experience App (EEA) is an event organizer application that allows users to register as admin, organizer, or volunteer. Each user role comes with its own set of privileges and functionalities. EEA provides a platform for users to RSVP for upcoming events, create, update, read, and delete events, and organize tasks specific to each event. This README provides an overview of the application and its key features.
User Registration: Users can register with the application and select their role as admin, organizer, or volunteer. The registration process requires basic user information such as name, email, and password.
User Authentication: EEA provides secure user authentication to ensure that only authorized users can access the application. User login requires a valid email and password.
Event RSVP: Users can browse and RSVP for upcoming events. This feature allows users to indicate their interest and attendance for specific events.
Event Management: Admin and organizers have the ability to create, update, read, and delete events. They can provide event details such as name, date, time, location, description, and any additional information.
Task Organization: Users can create task lists specific to each event. This feature helps in organizing and assigning tasks to different users or teams. Tasks can be marked as completed and tracked for progress.
Notifications: Users receive notifications regarding event updates, changes, or any important information related to their role or the events they are involved in.
Admin: The admin role has full access and control over the application. They can manage users, create, update, and delete events, and have access to all features and functionalities.
Organizer: Organizers have the ability to create, update, and delete events. They can manage tasks, view RSVPs, and communicate with volunteers. However, they do not have administrative privileges such as user management.
Volunteer: Volunteers can RSVP for events, view event details, and access task lists. They can mark tasks as complete and communicate with organizers or other volunteers. Volunteers have limited access compared to admins and organizers.
To run the client-side application locally, clone this repo and open a terminal in the /client directory. If this is the first time you are running the application, first run "npm install" (to install dependencies) and then "npm run prepare" (to set up Material UI themes and compile .scss). After you've done that, "npm run dev" is all you need to do to get a local server working.
Depending on your operating system, follow the specific link at https://docs.docker.com/compose/install/
After installing Docker, cd into eventexperenceapp. Run docker compose up. When done with testing, run docker compose down. This will free up some resources on your computer
Once the application is installed and running, users can perform the following actions:
We welcome contributions to enhance the Event Experience App. If you would like to contribute, please follow these steps:
- Black is a PEP 8 compliant opinionated formatter
Black requires Python 3.7+ and can be installed by running pip install black
python --versionIn order to get started with current files, run black {source_file_or_directory}
python -m black {source_file_or_directory}