thaiq8nguyen / school-calendar-fe

Lambda Lab 17 Project

1️⃣ School Calendar

1️⃣ You can find the deployed project at [🚫URL NAME GOES HERE](🚫copy and paste URL here).

4️⃣ Contributors

| Maksim Vakarchuk | Thai Nguyen | Augustine Rodriguez | Zach Young | Landry Irakoze | | Fnu Bharti | Aaryn | Carlos Hernandez |

Project Overview

1️⃣ Trello Board

1️⃣ Product Canvas

1️⃣ [UX Design files](🚫add link to design files here) - 🚫 delete if not applicable

School Calendar was an app idea brought to Lambda from a school coach. The coach would like a calendar that he could update with various events and push to a larger source i.e. google, outlook, or Ical.

Along with these things notifying changes to a schedule the coach would like to update things inside the events such as time and location. The last key feature would be event templates that can be placed in bulk across unrelated days.

4️⃣ Key Features

• Event template creation
• Re-Occuring Events
• Interactive Visual Calendar
• Third Party Calendar Integration
• Notifications

1️⃣ Tech Stack

Front end built using:

React Hooks

• Provides good code bases for things like calendars.
• Group knowledge of it.
• hooks makes things more simple

Front end deployed to 🚫insert service here

Back end built using:

FireBase

• Easier Set Up
• Easier Third Party Integration
• Less Information to manage

APIs

2️⃣ FireBase Authentication

Using FireBase authentication, Firebase handles most of the information for us while giving us multiple options with which we can log in. The two forms of authentication we are using is email and password, and google login.

3️⃣ Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following: (I can update to the actual .env code)

export const config = {
  apiKey: process.env.REACT_APP_API_KEY,
  authDomain: process.env.REACT_APP_AUTH_DOMAIN,
  databaseURL: process.env.REACT_APP_DATABASE_URL,
  projectId: process.env.REACT_APP_PROJECT_ID,
  storageBucket: process.env.REACT_APP_STORAGE_BUCKET,
  messagingSenderId: process.env.REACT_APP_MESSAGING_SENDER_ID,
  appId: process.env.REACT_APP_APP_ID,
  measurementId: process.env.REACT_APP_MEASUREMENT_ID
};

5️⃣ Content Licenses

Image Filename	Source / Creator	License

4️⃣ Testing

4️⃣ Installation Instructions

With this project NPM was used. The Dependancies are as followed; "@date-io/moment": "^1.3.11", "@fullcalendar/core": "^4.3.1", "@fullcalendar/daygrid": "^4.3.0", "@fullcalendar/interaction": "^4.3.0", "@fullcalendar/react": "^4.3.0", "@fullcalendar/timegrid": "^4.3.0", "@material-ui/core": "^4.5.1", "@material-ui/icons": "^4.5.1", "@material-ui/pickers": "^3.2.7", "@material/snackbar": "^3.2.0", "firebase": "^7.2.0", "formik": "^1.5.8", "fullcalendar-reactwrapper": "^1.0.7", "moment": "^2.24.0", "node-sass": "^4.12.0", "react": "^16.10.2", "react-dom": "^16.10.2", "react-router": "^5.1.2", "react-router-dom": "^5.1.2", "react-scripts": "3.2.0", "yup": "^0.27.0"

Other Scripts

"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See [Backend Documentation](🚫_link to your backend readme here_) for details on the backend of our project.