readme.md 2.84 KB
Newer Older
Aral Balkan's avatar
Aral Balkan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
# Better

You’re at the right place to get started as a Better developer or inspector.

## Start here.

Run `./install` to set up your development environment.

This will carry out a full installation and install [Better Inspector](https://source.ind.ie/better/inspector), [Builder](https://source.ind.ie/better/builder), [iOS App](https://source.ind.ie/better/app) and [Safari Extension](https://source.ind.ie/better/safari).

For more information, see [full installation details](#full-installation-details).

### Inspector-only installation

If you only want to help with inspections and not develop for the Better iOS App or Better Safari Extension, run:

`./install --inspector`

This will install just the Better Inspector and Better Builder.

## Full installation details

[Better is made up of a number of components.](https://source.ind.ie/groups/better)

To get started as a Better inspector or developer, you do not have to worry about how everything works or needs to be set up.

Just clone this repository and run the `./install` script and you’ll be good to go.

Once you’re up and running, however, it will help to have a better understanding of the important components and how they fit together.

A full installation of Better sets up the following components:

### Key components

  * [**Inspector**](https://source.ind.ie/better/inspector) (`inspector/`)
  * [**Builder**](https://source.ind.ie/better/builder) (`builder/`)
  * [**iOS app**](https://source.ind.ie/better/app) (`app/`)
  * [**Safari extension**](https://source.ind.ie/better/safari) (`safari/`)

40
### Key content
Aral Balkan's avatar
Aral Balkan committed
41

Aral Balkan's avatar
Aral Balkan committed
42
The installer creates a folder for Better content at `~/better.fyi` with the following structure:
Aral Balkan's avatar
Aral Balkan committed
43 44 45 46 47 48 49 50 51

  * [content](https://source.ind.ie/better/content): content that you can see on better.fyi and in the app
  * [themes](https://source.ind.ie/better/themes): the themes, which, when combined with the content (above) generate the site and app data (see below)
  * [data](https://data.better.fyi): the site and app data generated by the builder
  * [drafts](https://drafts.better.fyi): draft tracker and site entries created by the Inspector
  * [archive](https://archive.better.fyi): HTTP Archive files saved by the Inspector from inspections and inquiries

### Secondary components & content

Aral Balkan's avatar
Aral Balkan committed
52
You will also find a hidden `.private` folder in `~/better.fyi` which, under normal circumstances, you should not have to bother with.
Aral Balkan's avatar
Aral Balkan committed
53

Aral Balkan's avatar
Aral Balkan committed
54
The private folder has the following structure:
Aral Balkan's avatar
Aral Balkan committed
55

56 57 58 59
  * *content.git:* the local bare git repository for the content
  * *themes.git:* the local bare git repository for the themes
  * *data/app.git:* the local bare git repository for the generated data for the app
  * *data/site.git:* the local bare git repository for the generated data for the site
Aral Balkan's avatar
Aral Balkan committed
60 61
  * *config:* stores configuration files (currently only for the builder)
  * *logs:* logs (currently only for the builder)