Forking this repo via forking this project on GitHub is not recommended, as it will tie your project directly to our repo. Instead, we recommend taking the following steps.
- Clone this repo locally.
- From the root of this repo,
rm -rf .git
- Intialize a new git repository,
git init
.
TBD
Instructions for co-development with Apollos Apps
First of all, to those of you who remember, the Monorepo, I'm sorry, stick with me. You'll need to change how you work slightly now that the app themselves have been split out, but you'll still get the same great features.
- From this repo, cd into apollos-church-api and ThePorch and run
yarn install
. - Edit your
.env. in ThePorch, and add a relative or direct path to your apollos-apps root under the
APOLLOS_APPS_LOCATIONvariable. ex:
APOLLOS_APPS_LOCATION='../../apollos-prototype'. - From the root of
apollos-apps
, runyarn link-packages
. You only need to run this once - From the root of this repo, run
yarn link-packages
. You only need to run this once
- If you are working on API packages, cd into the
apollos-apps
project and runyarn build:api-watch
. If you don't do this, you can still run the app, but you won't get live updates on changes to the API packages. - From this repo, run
yarn start
. Just like the good old days.
Q: Why linkemon
? How is it different than nodemon
?
A: linkemon
will refresh the app if symlinked (yarn linked) packages are changed.
Q: Who do I yell at if things are broken? A: @vinnyjth
Q: Do I need to set that APOLLOS_APPS_LOCATION
variable?
A: Yes. Because metro
doesn't support symlinks, we need to use wml
, which needs to know where the packages live on disk.