This project was bootstrapped with Create React App.

This project uses Firebase.

The live website is deployed here.

Pre-requisites

You need node, yarn, and npm installed on your machine.

git clone https://github.com/christopherread/springout.git

Clones the git repo locally

cd springout

npm install

Installs all the necessary packages for the project, including react-scripts.

cd functions

npm install

cd..

Installs all the necessary packages for the Firebase functions, including react-scripts.

npm install -g firebase-tools

Install the Firebase CLI tools globally.

firebase login

Logs into Firebase. This project requires a Firebase project to run.

Update src/firebase/firebase.cfg with the API keys for your Firebase project.

To communicate with external APIs (e.g. Slack), your Firebase project will be to be Blaze / PAYG paid tier.

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

firebase deploy --only hosting

Deploys the web app to Firebase hosting. It will deploy the last production build from your 'yarn build' command.

firebase deploy --only functions

Deploys the back-end to Firebase. These are server-less functions that run on Google Cloud.

firebase functions:config:set slack.app_id="MYSLACKAPPID"

firebase functions:config:set slack.client_id="MYSLACKCLIENTID"

firebase functions:config:set slack.signing_secret="MYSLACKCLIENTSECRET"

firebase functions:config:set slack.client_secret="MYSLACKCLIENTSECRET"

To connect to a Slack app / bot to the back-end, you need to set some environment variables in Firebase.
These are used when communicating with the Slack API
You will find these on the dashboard where you registered your Slack app.