forked from jsnbuchanan/crowd-funder-for-time-pwa
doc: Add instructions to become test user, and other README refactors.
This commit is contained in:
36
README.md
36
README.md
@@ -3,36 +3,9 @@
|
|||||||
[Time Safari](https://timesafari.org/) allows people to ease into collaboration: start with expressions of gratitude
|
[Time Safari](https://timesafari.org/) allows people to ease into collaboration: start with expressions of gratitude
|
||||||
and expand to crowd-fund with time & money, then record and see the impact of contributions.
|
and expand to crowd-fund with time & money, then record and see the impact of contributions.
|
||||||
|
|
||||||
## Database Migration Status
|
|
||||||
|
|
||||||
**Current Status**: The application is undergoing a migration from Dexie (IndexedDB) to SQLite using absurd-sql. This migration is in **Phase 2** with a well-defined migration fence in place.
|
|
||||||
|
|
||||||
### Migration Progress
|
|
||||||
- ✅ **SQLite Database Service**: Fully implemented with absurd-sql
|
|
||||||
- ✅ **Platform Service Layer**: Unified database interface across platforms
|
|
||||||
- ✅ **Settings Migration**: Core user settings transferred
|
|
||||||
- ✅ **Account Migration**: Identity and key management
|
|
||||||
- 🔄 **Contact Migration**: User contact data (via import interface)
|
|
||||||
- 📋 **Code Cleanup**: Remove unused Dexie imports
|
|
||||||
|
|
||||||
### Migration Fence
|
|
||||||
The migration is controlled by a **migration fence** that separates legacy Dexie code from the new SQLite implementation. See [Migration Fence Definition](doc/migration-fence-definition.md) for complete details.
|
|
||||||
|
|
||||||
**Key Points**:
|
|
||||||
- Legacy Dexie database is disabled by default
|
|
||||||
- All database operations go through `PlatformServiceMixin`
|
|
||||||
- Migration tools provide controlled access to both databases
|
|
||||||
- Clear separation between legacy and new code
|
|
||||||
|
|
||||||
### Migration Documentation
|
|
||||||
- [Migration Guide](doc/migration-to-wa-sqlite.md) - Complete migration process
|
|
||||||
- [Migration Fence Definition](doc/migration-fence-definition.md) - Fence boundaries and rules
|
|
||||||
- [Database Migration Guide](doc/database-migration-guide.md) - User-facing migration tools
|
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
See [project.task.yaml](project.task.yaml) for current priorities.
|
See [ClickUp](https://sharing.clickup.com/9014278710/l/h/8cmnyhp-174/10573fec74e2ba0) for current priorities.
|
||||||
(Numbers at the beginning of lines are estimated hours. See [taskyaml.org](https://taskyaml.org/) for details.)
|
|
||||||
|
|
||||||
## Setup & Building
|
## Setup & Building
|
||||||
|
|
||||||
@@ -42,14 +15,16 @@ Quick start:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install
|
npm install
|
||||||
npm run dev
|
npm run build:web:serve -- --test
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To be able to make submissions: go to "profile" (bottom left), go to the bottom and expand "Show Advanced Settings", go to the bottom and to the "Test Page", and finally "Become User 0" to see all the functionality.
|
||||||
|
|
||||||
See [BUILDING.md](BUILDING.md) for comprehensive build instructions for all platforms (Web, Electron, iOS, Android, Docker).
|
See [BUILDING.md](BUILDING.md) for comprehensive build instructions for all platforms (Web, Electron, iOS, Android, Docker).
|
||||||
|
|
||||||
## Development Database Clearing
|
## Development Database Clearing
|
||||||
|
|
||||||
TimeSafari provides a simple script-based approach to clear the database for development purposes.
|
TimeSafari provides a simple script-based approach to clear the local database (not the claim server) for development purposes.
|
||||||
|
|
||||||
### Quick Usage
|
### Quick Usage
|
||||||
```bash
|
```bash
|
||||||
@@ -126,7 +101,6 @@ const apiUrl = `${APP_SERVER}/api/claim/123`;
|
|||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
- [Domain Configuration System](docs/domain-configuration.md) - Complete guide
|
|
||||||
- [Constants and Configuration](src/constants/app.ts) - Core constants
|
- [Constants and Configuration](src/constants/app.ts) - Core constants
|
||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
|
|||||||
Reference in New Issue
Block a user