GalaGuide

GalaGuide is an MIT-licensed open-source cross-platform software application as your personal manager for campus events & reservations based on Electron, Vue, and Ktor.

GitHub:

Features

• Event management

  • Smart recommendation
  • Smooth event creation experience
  • Easy-to-use event search
  • Simple event registration
  • Just-in-time event notification
  • Step-by-step guide for event participation

• Reservation management

  • Scalable reservation system for personal and group use
  • Able to handle various types of reservations
  • Easy information gathering for reservation
  • Clear reservation status display
  • Reminder for reservation status

• Live chat: Communicate with others in real-time

  • Real-time chat with other users
  • Group chat in the same event
  • Chat history for each event updated in real-time
  • Chatbot for common questions

• Forum: Share your thoughts and experiences

  • Post and reply to threads
  • Upvote and downvote threads
  • Search for threads
  • Filter threads by category

• AI assistant

  • Smart recommendation for events and reservations
  • Chattable AI assistant
  • Voice assistant for hands-free operation

• Interactive map

  • Campus map with event locations
  • Navigation to event locations
  • Real-time location tracking

• Calendar

  • Personal calendar for event and reservation management
  • Sync with other calendar applications
  • Reminder for upcoming events and reservations

Getting Started

Take a look at the wiki for more information about the project.

The GitHub repository provides both backend and frontend code. The backend is based on Ktor, and the frontend is based on Vue. You could also find the pre-built executable files in the release page. The following instructions will help you to build the project from source code. So if you only want to run the application using the executable file, you can skip the following steps.

Using pre-built executable files

See the releases.

Building from source code

Installation

1. Clone the repository

git clone https://github.com/sustech-cs304/galaguide.git

2. Enter the directory galaguide/ and install the dependencies for the frontend

npm install

3. Build the backend

TODO

4. Install the requirements for the backend for AI

cd ../ai
pip install -r requirements.txt

Usage

1. Run the backend

In backend/:

./gradlew runFatJar

In ai/:

python app.py

2. Enter the directory galaguide/ and run the frontend

npm run electron:serve

After running the frontend, you should see the application window.

Other

Future work

The objective of GalaGuide is to provide a comprehensive event and reservation management system for campus users. The current version of GalaGuide is a prototype, and there are many features that can be added in the future. You could find the future work in the wiki and if you have any ideas, feel free to open an issue or pull request.

Contributing

Any contributing and pull requests are welcomed. However, before you plan to implement some features or try to fix an uncertain issue, it is recommended to read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

About the logo

The logo of GalaGuide is designed by Jianzheng Huang using AI tools. The logo is inspired by the concept of a compass, which represents the guidance and direction provided by GalaGuide. The logo is designed to be simple and easy to recognize, with a color scheme that is easy on the eyes.

Contact

If you have any questions or suggestions, feel free to contact us via email or GitHub issues. You could find the contact information in the wiki.

Sponsoring

Open source development is not free and cannot be sustained without your support. If you like GalaGuide and want to support the development, you could sponsor us via GitHub Sponsors. You could find the sponsor button on the top right of the repository page. ❤️

Acknowledgements

To see a world in a grain of sand,

And a heaven in a wild flower,

Hold infinity in the palm of your hand,

And eternity in an hour.

• William Blake, Auguries of Innocence

GalaGuide is originally a team project for the course CS304 Software Engineering (Spring 2024) at Southern University of Science and Technology (SUSTech). The team members are (in ascending order of Pinyin):

• Hanran Zhou
• Haodong He
• Jianzheng Huang
• Lianji Bai
• Qiwen Xiao

We would like to thank the course instructor, Yida Tao, and the teaching assistants for their guidance and support during the development of GalaGuide, and the open-source community for providing us with the tools and resources to build GalaGuide, and also ourselves for the hard work and dedication to the project throughout the semester.

And lastly, a deep bow to you for using GalaGuide and supporting open-source development.

License

This project is licensed under the MIT License - see the LICENSE file for details.