Browse Source

enhance documentation

pull/92/head
Trent Larson 12 months ago
parent
commit
fa41fb3415
  1. 18
      README.md
  2. 5
      project.task.yaml
  3. 2
      src/views/HomeView.vue
  4. 2
      src/views/ImportAccountView.vue

18
README.md

@ -13,6 +13,11 @@ npm install
npm run serve npm run serve
``` ```
### Lints and fixes files
```
npm run lint
```
### Compiles and minifies for production ### Compiles and minifies for production
If you are deploying in a subdirectory, add it to `publicPath` in vue.config.js, eg: `publicPath: "/app/time-tracker/",` If you are deploying in a subdirectory, add it to `publicPath` in vue.config.js, eg: `publicPath: "/app/time-tracker/",`
@ -21,11 +26,7 @@ If you are deploying in a subdirectory, add it to `publicPath` in vue.config.js,
npm run build npm run build
``` ```
### Lints and fixes files ... then copy the contents of the `sw_scripts` folder to the `dist` folder - except additional_scripts.js.
```
npm run lint
```
@ -91,9 +92,12 @@ For your own web-push tests, change the 'vapid' URL in App.vue, and install apps
- Click on the "Registration Unknown" button and register that person to be able to make claims as them. - Click on the "Registration Unknown" button and register that person to be able to make claims as them.
### Clear data & restart ### Clear/Reset data & restart
Clear the browser cache for localhost. * Data: Clear the browser cache for localhost.
* Notifications:
* Under browser settings, look for "notification" and remove this server.
* Under about:debugging, find the service worker and Unregister.

5
project.task.yaml

@ -1,13 +1,17 @@
tasks: tasks:
- remove hard-coded anomalistlabs.com
- don't show "Give" & "Offer" on project screen if they don't have an identifier - don't show "Give" & "Offer" on project screen if they don't have an identifier
- allow some gives even if they aren't registered - allow some gives even if they aren't registered
- in endorser-push-server - mount folder for persistent sqlite DB outside of container - in endorser-push-server - mount folder for persistent sqlite DB outside of container
- extract private_key_hex in webpush.py
- 40 notifications : - 40 notifications :
- push, where we trigger a ServiceWorker(?) in the app to reach out and check for new data assignee:matthew - push, where we trigger a ServiceWorker(?) in the app to reach out and check for new data assignee:matthew
- .2 change the "claims" verbiage in feeds (eg. safari-notifications.js)
- .5 allow to manage their notifications even without an identity - .5 allow to manage their notifications even without an identity
- 01 Ensure each action sent to the server has a confirmation - eg registration (ie a toast something that dismisses after 5-10s) - 01 Ensure each action sent to the server has a confirmation - eg registration (ie a toast something that dismisses after 5-10s)
- .3 fix the Project-location-selection map display to not show on top of bottom icons (and any other UI tweaks on the map flow) assignee-group:ui - .3 fix the Project-location-selection map display to not show on top of bottom icons (and any other UI tweaks on the map flow) assignee-group:ui
@ -51,6 +55,7 @@ tasks:
- 08 convert to cleaner implementation (maybe Drie -- https://github.com/janvorisek/drie) - 08 convert to cleaner implementation (maybe Drie -- https://github.com/janvorisek/drie)
- Release Minimum Viable Product : - Release Minimum Viable Product :
- generate new webpush.db entries, data/webpush.db private_key_hex & subscription_info & vapid_claims email
- .5 deploy endorser.ch server above Dec 1 (to get plan searches by names as well as descriptions) - .5 deploy endorser.ch server above Dec 1 (to get plan searches by names as well as descriptions)
- 08 thorough testing for errors & edge cases - 08 thorough testing for errors & edge cases
- 01 ensure ability to recover server remotely, and add redundant access - 01 ensure ability to recover server remotely, and add redundant access

2
src/views/HomeView.vue

@ -104,7 +104,7 @@
class="border-b border-dashed border-slate-400 text-orange-400 pb-2 mb-2 font-bold uppercase text-sm" class="border-b border-dashed border-slate-400 text-orange-400 pb-2 mb-2 font-bold uppercase text-sm"
v-if="record.jwtId == feedLastViewedId" v-if="record.jwtId == feedLastViewedId"
> >
You've seen all claims below: You've seen all the following before
</div> </div>
<div class="flex"> <div class="flex">
<fa icon="gift" class="pt-1 pr-2 text-slate-500"></fa> <fa icon="gift" class="pt-1 pr-2 text-slate-500"></fa>

2
src/views/ImportAccountView.vue

@ -76,7 +76,7 @@ import { MASTER_SETTINGS_KEY } from "@/db/tables/settings";
components: {}, components: {},
}) })
export default class ImportAccountView extends Vue { export default class ImportAccountView extends Vue {
UPORT_DERIVATION_PATH = "m/7696500'/0'/0'/0'"; UPORT_DERIVATION_PATH = "m/7696500'/0'/0'/0'"; // for legacy imports, likely never used
mnemonic = ""; mnemonic = "";
address = ""; address = "";

Loading…
Cancel
Save