Skip to content

Latest commit

 

History

History
153 lines (103 loc) · 6.23 KB

README.md

File metadata and controls

153 lines (103 loc) · 6.23 KB
Raw

Open in Visual Studio Code

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Code of Conduct
  5. Contributing
  6. Contact
  7. Acknowledgments

About The Project

The goal of the project is to create a user-centric event management platform that enhances the experience of students, faculty, and staff at the University of Toronto (UofT) by providing an accurate and user-friendly solution for discovering, managing, and participating in events and activities. Our platform aims to serve as a one stop solution which significantly reduces the time and effort required to stay informed and engaged for students, clubs, and faculty members at the University of Toronto.

Getting Started

Steps to Run the application for development:

  1. Before you start making changes: docker-compose up -d
  2. Make changes locally when you'd like to test the change: refresh docker container through docker desktop or re-run docker-compose up -d
  3. All changes to the files within the app/ folder can be tested this way.
  4. Before pushing the code do - docker-compose up --build
  5. If everything works on the new container, you are all set to push the changes!
  6. After pushing the changes run docker-compose down to stop the container.

Roadmap

This is a near-term roadmap for the tasks that are priorotized by the team. A more detailed issue management information can be found on our GitHub Project management tool here.

  • Define the database schemas

  • Define database integrity constraints

  • Make login/register page

  • Make blank user entry page

  • Make blank organizer entry page

  • Make successful redirection for users/organizers

  • Make a credentials database and connect it with the website

  • Add functionality to register users

  • Add functionality to register organizers

  • Make a sample events database – 3-4 entries

  • Write automated tests to verify that the website is functional

  • Set up CI/CD pipelines around the project to aid developer experience

  • Show all users the same event feed from the events database

  • Add functionality for organizers to add an event to the database

  • Organize events in a list view for users

  • Organize events in a calendar view for users

  • Add sorting of events for users

  • Import events to Google calendar

  • Add ratings for organizer’s

  • Add ability for users to add ratings

  • Add functionality to assign tags to events (for organizers)

  • Add search for events (user side)

  • Add functionality to help users define and store their preference

See the open issues for a full list fetaures we are currently working on.

Code of Conduct

For guidelines on how to interact with this project, please refer to our Code of Conduct.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Please set the reviewers of your pull requests to either @pandyah5 or @snehshah09. For detailed instructions on contributions please read our CONTRIBUTION.md.

Contact

The best way to contact us is to join our discord server.

Acknowledgments

We would like to acknowledge the ECE444 Teaching Team from the University of Toronto, who has guided us all the way to build this project.

Deprecated Comments

Older version and explanation of commands: We have dockerized the project to prevent any complications that might arise from different environments. To run the application locally you can:

  • Initialize the python docker image using the Dockerfile we have added docker build -t python-docker .

  • Run the website locally on a specific port docker run -d -p 5000:5000 python-docker

If the port 5000 is busy, you can replace it with other ports like 3000.

  • In order to run the application ensure docker and docker-compose are downloaded
  • Run the website using: docker-compose up -d Note: the -d flag represents running the containers in detached mode. It basically will not show any logs on the terminal screen. To show logs for docker compose: docker-compose up

When re-running the code make sure to run: docker-compose up --build This will re-build your container as docker-compose tends to use the cached containers. Alternatively you can also use: docker-compose build --no-cache before you run the docker-compose up

After running the previous command, you should be able to access the website on your localhost:5000 link as we have been doing previously.

when you are done using the application, just run: docker-compose down