https://github.com/alexander-ding/commontime
Commonwealth School's scheduling app/website
https://github.com/alexander-ding/commontime
firebase react reactjs redux
Last synced: 5 months ago
JSON representation
Commonwealth School's scheduling app/website
- Host: GitHub
- URL: https://github.com/alexander-ding/commontime
- Owner: alexander-ding
- License: mit
- Created: 2020-05-14T16:47:55.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T12:25:30.000Z (over 3 years ago)
- Last Synced: 2025-08-16T23:31:29.345Z (11 months ago)
- Topics: firebase, react, reactjs, redux
- Language: JavaScript
- Homepage:
- Size: 1.58 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Commontime
This is the source code of [Commonwealth School](https://www.commschool.org/)'s scheduling app/website.
It is built using [React.js](https://reactjs.org/) and [Redux](https://redux.js.org/) with a Google Firebase backend. Email service is provided by [Mailjet](https://app.mailjet.com/). Error analytics is handled using [sentry.io](https://sentry.io/).
## Getting Started
### Requirements
First of all, if you want to contribute to the project, contact a current developer to add you the as a collaborator to the Firebase project.
Install [Node.js](https://nodejs.org/en/download/), and use it to install React by running
```npm install -g create-react-app```
Install the firebase CLI by running
```npm install -g firebase-tools```
Then sign into Firebase using your Google account by running
```firebase login```
Make sure that you're signing in with the Google account that has edit access to the Firebase project.
Clone this repository and cd into it. Install the npm packages for both the root directory (for the frontend) and the `functions` directory.
```npm install && cd functions && npm install```
`cd` back to the root directory and run
```npm run sync-config```
to clone the environmental variables set on the cloud to your local machine for development.
**Note**: use `firebase functions:config:set key.subkey=value` to config additional variables. Every time you make changes to the config variables, you must rerun `npm run sync-config` to update your local emulator to use the latest variables.
`cd` back to the project root directory.
### Local Development
My preferred setup is to have two shells open to the root directory of the project. On one, run `npm start` for the React development server. On another, run `npm run emulate` to start the Firebase function emulators.
You may access the [Firebase cloud console](https://console.firebase.google.com/) to play with the database.
**Please remember**: since the Firebase Firestore emulator is not well-supported yet, the local environment directly uses the production Cloud Firestore.
To deploy the build, simply run
```firebase deploy```
## Code Structure
The website frontend's source code is in `src`, and the Firebase cloud functions code is available in `functions`. `public` provides some static files for React to build the website with.