Add README with build/run instructions
This commit is contained in:
45
README.md
Normal file
45
README.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
# Signal Elsewhere
|
||||||
|
|
||||||
|
An interactive educational experience about money, technology, food, and health — built as a Capacitor Android app.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
The app is a single-page HTML/JS application. No build step is needed for the web version.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Serve locally for development
|
||||||
|
python3 -m http.server 8080
|
||||||
|
# or
|
||||||
|
npx serve .
|
||||||
|
```
|
||||||
|
|
||||||
|
Open `http://localhost:8080` in your browser.
|
||||||
|
|
||||||
|
## Android Build
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install dependencies
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# Copy web assets to Android
|
||||||
|
npx cap copy
|
||||||
|
|
||||||
|
# Sync Capacitor config
|
||||||
|
npx cap sync android
|
||||||
|
|
||||||
|
# Open in Android Studio
|
||||||
|
npx cap open android
|
||||||
|
```
|
||||||
|
|
||||||
|
From Android Studio, build and run on a device or emulator.
|
||||||
|
|
||||||
|
## Structure
|
||||||
|
|
||||||
|
- `index.html` — main application source
|
||||||
|
- `www/` — production web directory (copied to Android)
|
||||||
|
- `android/` — Android project (Capacitor)
|
||||||
|
- `capacitor.config.json` — Capacitor configuration
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
ISC
|
||||||
Reference in New Issue
Block a user