Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.23 KB

README.md

File metadata and controls

39 lines (26 loc) · 1.23 KB

css-colour-palette

A project for BC Hacks Lite's 2020 Halloween hackathon

Reactjs frontend important bits:

  • /index.js

    • root of the application
  • /public

    • reactjs generated public files, favicon and other goodies go here :)
  • /components:

    • all the component files for the react application
  • /components/firebase

    • files related to linking the react app with firebase, firebase.js needs to be edited with env variables to work (not going to expose them on github)
  • /components/App

    • files related to the main application page; css, index etc..

Running/Building The frontend is set to run from localhost on port 8080 for development.

npm start will run in development, to deploy npm run-script build to retrieve a /build folder with an optimized build to be hosted.

Firebase backend important bits:

  • .functions/

    • where all of the firebase functions information is stored
  • ./functions/index.js

    • where all of the functions to be called from the api are.

NOTE: firebase-tools must be installed to emulate the firebase code npm install firebase-tools to test in development, run fire-base emulators:start and go to the url:port it points to.