Commit f90d2d2e authored by Aral Balkan's avatar Aral Balkan
Browse files

Updated readme with new git-tag-based deployment process information.

parent 98d7ebe3
......@@ -2,30 +2,53 @@
Builds the data for the Better site and app using authored Better content in Blockdown format.
## Development
## Installation
Normally, you will not need to install this project manually, as the [Better iOS app](https://source.ind.ie/better/app) will install it for you. In case you want to install it separately from the iOS app, just run:
./install
## Usage
To generate the data, run:
To start the fully-offline local development environment and run your first build of the Better content, run:
./dev
To see the generated site, visit `http://localhost:3000`
To see the generated app data, run the [Better app](https://source.ind.ie/better/app) in the iOS Simulator.
To see the generated app data, run the [Better iOS app](https://source.ind.ie/better/app) in the iOS Simulator.
To update the generated data (locally):
### Updating generated data locally
1. Make a change to a Blockdown format file in your local working copy of the content repository (*~/better.fyi/builder/content/*)
2. `git commit -am "Your change"`
3. `git push`
3. `git push origin master`
At this point, your commit will simulate the Gitlab web hook that the production environment uses and trigger the Better build process. That, in turn, will push to the local site.
Visit `http://localhost:3000` to see the updated site and *~/better.fyi/builder/site-local/site/blockerList.json* for the updated WebKit blocker list.
## Pushing to live
If you have commit rights to the content or theme repositories, you can push to live with:
```bash
git push live master
```
## Deployment
Deploying content updates to the production environment is done via Git tags. If you have commit rights for the content repository, you can deploy to the production environment with:
1. `git tag -s "YYYYMMDD-000N"`
2. `git push live --tags`
This will trigger a build on *builder.better.fyi*.
The results will be available on next load for the iOS apps and immediately [on the Better web site](https://better.fyi).
You can also see the results of the build on [data.better.fyi](https://data.better.fyi) in the [app](https://data.better.fyi/generated/app/tree/master) and [site](https://data.better.fyi/generated/site/tree/master) generated data repositories.
## Production
To run Better in production, you will need to set up three servers:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment