This project is a Create React App + Firebase project.
- Start by
git clone git@github.com:spatialdev/urban-carnivore-spotter.git - Request access to the Seattle Carnivores Firebase account by contacting Savannah, Sayana, or Micah.
- Run
npm install -g firebase-toolsto install the CLI for Firebase on your machine. - Navigate to the project's root directory and
npm ito install project dependencies. - Navigate to the
functionsdirectory andnpm ito install Firebase dependencies. - Navigate back to the root of the project and run
npm start. This will kick off the localhost port for development in your preferred browser. Any changes made during development withnpm startrunning will show up immediately in the browser. - You're now ready to develop!
Note that this project leverages Cloud Functions for all endpoints in the app. As such, to create a new endpoint, you'll need to add to the functions/index.js file. Once you have created a new function, you'll need to deploy the function to Firebase by running 'firebase deploy'. This operation should take a minute or two. You may run into some linting errors but once you've successfully deployed you should be able to view active functions here. As it currently stands, we have endpoints to add a new report, retrieve a single report, and retrieve the collection of reports based on some bounds and a set of filtering parameters.