diff --git a/README.md b/README.md index 4a1042e..fd6741e 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,34 @@ -# firebase-archiver-2 +# Aut Archiver Setup Tool +This project is a firebase/vue app that can connect to an instance of the [Auto Archive API](https://github.com/bellingcat/auto-archiver-api). -## Project setup -``` +![UI preview](docs/image.png) + +## development with yarn +```bash +# setup yarn install -``` -### Compiles and hot-reloads for development -```bash +# Compiles and hot-reloads for development yarn serve -``` -### Compiles and minifies for production -```bash +# Compiles and minifies for production yarn build -``` +# Previews the production build +yarn preview -### Lints and fixes files -```bash +# Lints and fixes files yarn lint ``` -### Customize configuration -See [Configuration Reference](https://cli.vuejs.org/config/). +### Release/development process +> You need a [firebase APP](https://firebase.google.com/) and a Google project, and as it stands you need to update the hardcoded APP identifiers ([here](src/store/index.js) and [here](firebase.json)); a PR on isolating that to .env is welcome. - -### Release process 1. install firebase locally 2. login to your firebase account with `firebase login` 3. make sure you have access to the project `firebase projects:list` -4. build `yarn build` and then release `firebase deploy --only hosting` -5. to update schedule functions `firebase deploy --only functions` +4. build `yarn build` and check with `yarn preview`, once all is good release `firebase deploy --only hosting` +5. to update schedule functions `firebase deploy --only functions` currently these are disabled 6. if you add any library to a function, install it inside the `/functions` folder and not in the root folder -7. to update secrets use `firebase functions:secrets:set SECRET_NAME` more info [here](https://firebase.google.com/docs/functions/config-env?gen=2nd#managing_secrets) - 1. `API_SERVICE_PASSWORD` for the auto-archiver-api - 2. `GOOGLE_API_CLIENT_EMAIL` and `GOOGLE_API_PRIVATE_KEY` for the scheduled function to validate sheets exist \ No newline at end of file + + + \ No newline at end of file diff --git a/docs/image.png b/docs/image.png new file mode 100644 index 0000000..2cdc73b Binary files /dev/null and b/docs/image.png differ diff --git a/ui-debug.log b/ui-debug.log deleted file mode 100644 index edaaf3e..0000000 --- a/ui-debug.log +++ /dev/null @@ -1,2 +0,0 @@ -Web / API server started at 127.0.0.1:4000 -Web / API server started at ::1:4000