St Andrews Anonymous Chat (stabubble)

This project was bootstrapped with Create React App.

Project structure

The project consists of three parts:

• React Web App hosted on Firebase Hosting
• Firebase Realtime Database with security rules
• Firebase Functions running server side functions

/

The top directory contains following files.

database.rules.bolt

Firebase Realtime Database rules describing access control rules in bolt language. This allows functions to be defined for validation, allowing much more readable rules when describing more complex rules. This practically defines the database.

database.rules.json

Firebase json database rules compiled from the firebase-bolt database rules.

Use firebase-bolt database.rules.bolt to compile.

database.spec.js

Firebase database test framework file defining unit tests. To run the tests locally:

1. database.rules.json has to be compiled from database.rules.bolt.
2. database emulator has to be running: e.g. firebase emulator:start --only database
3. npm run test-database

Any changes to the bolt database rules must be compiled down to json using firebase-bolt database.rules.bolt.

functions/

Server side code for Google Cloud Functions.

public/

Static assets for the React app.

src/

React app

src/constants.js

File intended to contain constants; currently, this only stores locations. The locations stored are key-value pair of id and name. id must not contain spaces; name can contain spaces and should be human-readable.

test/

Stores testing framework library code from: firebase rules github

Edited from original due to assertion bug

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

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

npm test

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

npm run 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.

npm run 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.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here

Analyzing the Bundle Size

This section has moved here

Making a Progressive Web App

This section has moved here

Advanced Configuration

This section has moved here

Deployment

This section has moved here

npm run build fails to minify

This section has moved here