bellingcat/auto-archiver-setup-tool
1
0
Fork 0
mirror of https://github.com/bellingcat/auto-archiver-setup-tool.git synced 2026-06-07 19:18:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

readme updates

Browse Source
This commit is contained in:
msramalho
2025-02-17 18:29:18 +00:00
parent ebe7286ce2
commit d83fbd2046
3 changed files with 19 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@@ -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 yarn install
```
### Compiles and hot-reloads for development # Compiles and hot-reloads for development
```bash
yarn serve yarn serve
```
### Compiles and minifies for production # Compiles and minifies for production
```bash
yarn build yarn build
``` # Previews the production build
yarn preview
### Lints and fixes files # Lints and fixes files
```bash
yarn lint yarn lint
``` ```
### Customize configuration ### Release/development process
See [Configuration Reference](https://cli.vuejs.org/config/). > 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 1. install firebase locally
2. login to your firebase account with `firebase login` 2. login to your firebase account with `firebase login`
3. make sure you have access to the project `firebase projects:list` 3. make sure you have access to the project `firebase projects:list`
4. build `yarn build` and then release `firebase deploy --only hosting` 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` 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 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) <!-- 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 <!-- 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 <!-- 2. `GOOGLE_API_CLIENT_EMAIL` and `GOOGLE_API_PRIVATE_KEY` for the scheduled function to validate sheets exist -->

BIN
docs/image.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 86 KiB

2
ui-debug.log
View File

@@ -1,2 +0,0 @@
Web / API server started at 127.0.0.1:4000
Web / API server started at ::1:4000