hangforever/hangzone-frontend

Description

An app that enables hangers from all over the world to discover and share zones in which to hang

This project was bootstrapped with Create React App. Bootstrapped, but there is some extra stuff in there to make it play nicely with firebase, etc.

Installation

Install yarn if you haven't already done so

$ npm install -g yarn

Install the firebase CLI

$ npm install -g firebase-tools

Clone and install deps

$ git clone git@github.com:hangforever/hangzone.git
$ cd hangzone
$ yarn bootstrap

Development

`yarn dev`

Runs the app in the development mode, as well as all the firebase emulators. Data will not be persisted between runs.
The CLI will tell you what port it's running locally on.

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

Debug Changing the .env file's REACT_APP_DEBUG_MODE var to "true" will cause the app to open to the "DebugZone".

`yarn backup`

Backup If you would like to persist the data you have in your emulated firebase, while the project is running, run yarn backup

`yarn dev:backup`

To start the project with that data you have saved, run the dev server with this command.

`yarn test`

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

TODO: find out how this works, lol

Adding static assets (images, etc)

You can put a static assets in src and import it.
You can put any static asset in the public directory and reference the path to it.

Resolution

'src' directory is added to paths so relative imports like './components/MyComponent' or '../components/MyComponent' can just be 'components/MyComponent'

View the Hangzone Firestore API Docs

You can view the API docs by using this command from root dir:

yarn docs:api

Deployments

`firebase deploy`

This will build any assets necessary and then upload them to firebase.

Other scripts

`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!

See the section about deployment for more information.

`yarn eject`

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

prettier:*

Please see the prettier repo for info. This will only run on ./src/* files.

On MobX

This application uses mobx for state management. Since the project was bootstrapped with create-react-app and CRA doesn't support decorators, we are using this guide for creating our stores: https://mobx.js.org/best/decorators.html

On Styles

This project uses Skeleton as a lightweight CSS framework http://getskeleton.com/