/RIVADatabaseOps-Rules

The ruleset safeguarding RIVAlumni's sensitive information database

Primary LanguageTypeScriptMIT LicenseMIT

RIVADatabaseOps - Firestore & Storage Rules

The ruleset safeguarding RIVAlumni's sensitive information database.

Installation

Use Git to download the source code.

git clone https://github.com/RIVAlumni/RIVADatabaseOps-Rules.git

And use Firebase Tools to initialize the Firestore & Storage emulators.

npm i -g firebase-tools@latest
firebase init firestore
firebase init storage

Usage

Development Testing

  1. Run npm run test:watch
  2. Write your tests.
  3. Check for any errors.

Production Testing

  1. Run npm test
  2. Open ui-report/index.html
  3. Read the entire report and ensure that no tests have failed.

Support

Note: This project is intended to only be used by RIVAlumni

Should you have any difficulties, please create a new issue and describe clearly the issue with reproducible steps.

Contributing

Note: Any pull requests that change the firestore / storage ruleset will be rejected. Should you feel a need to change the ruleset, please create a new issue.

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Authors

License

MIT