Gotta Get Outta This Space
The source code for "Gotta Get Outta This Space"
Support me making more cool stuff on Ko-fi
The Front-end
The front-end for this project uses Ionic React, in Typescript.
This front-end currently points to my firebase project. To point it towards a different project, change the configuration in src/firebaseConfig.ts
The front-end also relies on a pro license to FontAwesome 5. To remove these dependencies, see the guide below.
Run it locally
npm install
npm run start
Production Build
npm install
npm run build
Deployment
Deployment is via Github Actions. The current actions set up rely on the following secrets:
FONTAWESOME_PRO_TOKEN
- a fontawesome pro secretSURGE_LOGIN
- a surge usernameSURGE_TOKEN
- a surge token
The current actions would have to change to direct deployment to a different domain
Removing the Fontawesome dependency
npm uninstall @fortawesome/pro-regular-svg-icons
npm uninstall @fortawesome/pro-solid-svg-icons
Now remove dependencies on those two libraries in src/components/Game/Icons/index.tsx
. This will break some icons in the build.
The Backend - firebase functions
The Back-end of this project uses firebase functions, and can be found in the firebase
directory.
Deploying the functions
To deploy these functions you'll have to make a new firebase project. Follow the instructions here to get the firebase cli up and running on your computer.
You'll then need to modify the project aliases in the folder, so it's pointing at the right project.
Finally, there's a bunch of variables you'll need to set up (or remove the dependencies for):
slack.webhook
- the slack webhook that will recieve game updatescaptcha.secret
- the recaptcha (v3) secret to verify that forms aren't being filled in by robotsmailchimp.apikey
- the mailchimp api key for signing up to a mailing list