Skip to content

Update README.md #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sytion06 merged 1 commit into from
Dec 2, 2025
Merged

Update README.md #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
# GroupFlow

### GroupFlow is a group management service for students that enables seamless collaboration and scheduling between members.

## Features
- Create groups, invite members, and collaborate with meetings, tasks, and schedules to share amongst each other.
- Sign up with email to recieve notifications of members requesting to join your group.

## Installation
- Create a copy of this repository by running `git clone https://github.com/ingrid534/GroupFlow.git`.
- NOTE: In order to properly run this application, an API key is needed from [SendGrid API](https://sendgrid.com/en-us/solutions/email-api), which provides the sending of our email notifications.
- Once an API key is available, place it directly in `config/api_key.txt`.

## Runnning the Application
- Run the Java application in `src/main/java/app/Main.java`.
- Login with existing credentials, or sign up.
- Create or join groups via the dashboard home page.