- Description
- Download
- Install requirements
- Connect to APIs
- Start server
- Host server to public URL using ngrok
- Add users to groups
- Demos
Plan-A Headstarter is a group scheduling web application with video calling and calendar sharing all in one place! Schedule events, join meetings, collaborate with your team, and plan ahead[starter] with this easy-to-use dashboard!
- Register and login with email
- Calendar - schedule and delete events on the interactive group calendar
- Video Meet - video call with your group
- About - learn more about the creators of Plan-A Headstarter
- Help - submit a help form to the support team
git clone https://github.com/jakeenea51/Plan-A-Headstarter.git
npm install
To connect to your database, create a firebase project and insert the configuration information into the src/services/firebase.js file.
To connect to the video calling service, create an Agora project and insert the App ID and a temporary meeting token into the src/services/settings.js and src/pages/components/VideoRoom.js files.
npm start
Create ngrok account and download ngrok zip folder (here). Enter ngrok directory in terminal and run the following commands:
ngrok config add-authtoken <ngrok auth token>
ngrok http 3000
Adding users to groups is done manually through the firestore database. To add a user to a group create the following collections:
- Name the first collection the same as the user's UID (found in the authentication section of your firebase project).
- Add a new document to this collection titled groupInfo, and add two fields:
- group = {group1, group2, etc...}
- backColor = {hex color code}
- If not already created, name the second collection the same as the group name assigned in the previous step.