-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
62 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,4 @@ | ||
# Baby Buddy (Sandstorm app) | ||
|
||
:exclamation: WORK IN PROGRESS :exclamation: | ||
# Baby Buddy Sandstorm App | ||
|
||
This is the source for the [Baby Buddy](https://github.com/babybuddy/babybuddy) | ||
app for [Sandstorm](https://sandstorm.io/). | ||
|
@@ -9,4 +7,64 @@ app for [Sandstorm](https://sandstorm.io/). | |
|
||
- Baby Buddy currently only supports setting the application time zone from an | ||
environment variable. This cannot be achieved with the regular Sandstorm grain | ||
workflow, so the timezone is locked to Etc/UTC. | ||
workflow, so the timezone is locked to Etc/UTC. | ||
|
||
- Sandstorm user ID's are used for the username in Baby Buddy. This name is | ||
used for display throughout the app and is not terribly useful. | ||
|
||
- Baby Buddy's API has not been fully implemented with Sandbox's API | ||
integration. | ||
|
||
## Development | ||
|
||
Primary development for the Baby Buddy application occurs at [Baby Buddy](https://github.com/babybuddy/babybuddy) | ||
on GitHub. This repository is specifically for the Sandstorm app build process. | ||
|
||
### Sandstorm configuration | ||
|
||
The primary files for the Sandstorm app configuration are: | ||
|
||
- [`setup.sh`](.sandstorm/setup.sh): Installs nginx, uwsgi, pipenv, sqlite3 and | ||
git. | ||
|
||
- [`build.sh`](.sandstorm/build.sh): Gets Baby Buddy application code from | ||
GitHub, creates an `.env` file for the application with settings location and a | ||
`SECRET_KEY`, checks out the version specified in [`sandstorm-pkgdef.capnp`](.sandstorm/sandstorm-pkgdef.capnp) | ||
and establishes the virtual environment. | ||
|
||
- [`launcher.sh`](.sandstorm/launcher.sh): Prepares system directories, runs | ||
application migrations, and starts uwsgi and nginx. | ||
|
||
### Updating Baby Buddy | ||
|
||
Follow the steps below to update the version of Baby Buddy shipped with the | ||
Sandstorm app: | ||
|
||
1. Clone this repository. | ||
|
||
git clone [email protected]:babybuddy/babybuddy-sandstorm.git | ||
|
||
1. Move in to the repository. | ||
|
||
cd babybuddy-sandstorm | ||
|
||
1. Open the [`sandstorm-pkgdef.capnp`](.sandstorm/sandstorm-pkgdef.capnp) file | ||
and set the "appMarketingVersion" directive to a new version of Baby Buddy and | ||
increment the "appVersion" directive by one. | ||
|
||
editor .sandstorm/sandstorm-pkgdef.capnp | ||
|
||
1. Run the Vagrant SPK dev instance. | ||
|
||
vagrant-spk dev | ||
*Note: Confirm that [`sandstorm.patch`](sandstorm.patch) still applies | ||
during this command execution and update the patch if necessary.* | ||
|
||
1. Test new/modified functionality in the Sandstorm dev environment. | ||
|
||
browse http://local.sandstorm.io:6080 | ||
1. When ready, stop the development app (Ctrl-C) and pack the new APK. | ||
|
||
vagrant-spk pack ~/babybuddy.spk |