Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 6.22 KB

README.md

File metadata and controls

79 lines (54 loc) · 6.22 KB
Raw

Let's Plan logo

The status badge for this project's build FOSSA status This project is scanned by Snyk

Webapp • Infrastructure • Firebase Functions

A simple React/Redux based trip planner. Let's Plan is designed to be mobile- and offline- first, with added support for sync and sharing with friends. Cloud services (accounts, sync, image hosting) are provided through Firebase.

Development

Please check CONTRIBUTING.md first :)

This project requires a few Firebase resources, and isn't designed to work without it. Specifically, the following features are used:

  • Storage - All trip images are stored here, because local storage has a low maximum capacity. Storage rules are set up so everyone can view but only the owner of a firestore document with the same ID can upload.
  • Firestore - Logged-in users store their documents here - this enables cloud sync and optionally sharing with others. Rules are set up to prevent other uses editing others trips or viewing private trips.
  • Authentication - Users can log in via email/social, this lets us create the sync experience without handling authentication and security related functionality (e.g. password reset, MFA.)
  • Hosting - A GitHub action triggers deployments to upload the latest build to Hosting.
  • Cloud Functions - See code in dylmye/lets-plan-firebase-functions - currently this feature is used to delete trip items (because Firestore is poorly designed such that it doesn't let you delete all items in subcollections automatically) as well as trip images when a cloud-synced trip is deleted.

If you want this functionality without Firebase, you'll need to add that yourself.

Install

First, install dependencies:

$ yarn

Secondly, if you're not using Firebase you can remove .firebaserc, .firebase.json and the firebase scripts in the .github folder.

Copy the .env.example file and rename it .env. Set the parameters as so:

  • REACT_APP_GMAP_JS_API_KEY: To use the global address lookup, this project uses Google Maps API. Set this value to your API key, and make sure you have Places API enabled for your project.
  • REACT_APP_FIREBASE_*: Please plug in the values from the firebaseConfig provided when you make a web app. You can find them in the "your apps" section of the project settings.
  • REACT_APP_SIMPLE_ANALYTICS_URL: You can disregard this if you're not using Simple Analytics. If you're not using a custom domain, set this to scripts.simpleanalyticscdn.com. Otherwise set it to your custom.domain.com.
  • REACT_APP_SIMPLE_ANALYTICS_PIXEL_URL: You can disregard this if you're not using Simple Analytics. If you're not using a custom domain, set this to queue.simpleanalyticscdn.com. Otherwise set it to your custom.domain.com.
  • REACT_APP_UBER_API_CLIENT_ID: You can disregard this if you're not using the Uber API for taxi journey links. This is for the "CLIENT_ID" parameter for Uber's Ride Requests API, which is used to link to Uber in taxi itinerary items (see here.)
  • REACT_APP_HCAPTCHA_SITE_KEY: You can disregard this if you're not using HCaptcha (an anti-bot tool like Recaptcha). This is the site key from the dev portal linked to your domain.
  • REACT_APP_RELEASE_VERSION: Used in the app to display what version of LP is running. Useful for debugging. (optional)
  • REACT_APP_RAPIDAPI_KEY: Used for the Aviation Reference Data API, to get airlines and airports. Get one by signing up at RapidAPI. You can disregard this if you don't want this feature.

To make this project your own, you also need to:

  • Remove the scripts and HTML comments from public/index.html
  • Set the homepage field in the package.json to the URL you'll be hosting the website on (to make the service worker work)
  • Remove helpers/analytics.ts + any references to it, or change it to use the analytics package you use
  • Remove the credit footer in the Navbar component

Now you can run yarn start to spin up the local webserver.

Build

If you want to use Firebase Hosting, this project will deploy to your hosting URL on every push to main branch. Follow the instructions here for setup.

To manually build, run yarn build.

Note: if you're using Simple Analytics and converting this project to use SSR, you need to install it manually. The Simple Analytics ESM plugin doesn't support SSR.

Credits

This project was bootstrapped with Create React App, using the Redux and Redux Toolkit template.

Logo - Travel by Iconstock from NounProject.com