Skip to content

Commit 2bd91a9

Browse files
committed
Improve README.md
1 parent 14550eb commit 2bd91a9

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
> ℹ️ Issues for this repository are tracked on [Phabricator](https://phabricator.wikimedia.org/project/board/5563/) - ([Click here to open a new one](https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?tags=wikibase_cloud,wbstack_api
22
))
3-
>
3+
44
# WBStack Platform API
55
## Configuration
66
The platform API comes in a few different flavours that can be toggled using environment variables:
@@ -9,22 +9,19 @@ The platform API comes in a few different flavours that can be toggled using env
99
- `ROUTES_LOAD_SANDBOX` - web routes for the public facing sandbox usecase
1010
- `ROUTES_LOAD_BACKEND` - internal only API endpoints (non public) for all usecases
1111

12-
This single application could likely be split up at some point.
13-
Everything is currently together to make use of the shared wiki management code
14-
and query service management code.
12+
This single application could likely be split up at some point. Everything is currently together to make use of the shared wiki management code and query service management code.
1513

1614
## Additional environment variables
1715
### Contact page settings
18-
- `WBSTACK_CONTACT_MAIL_SENDER` - The mail address of the sender address of the contact page mails.
19-
If the address includes the placeholder `<subject>`, it gets replaced with a shorthand for the actual selected subject (`give-feedback`, `report-a-problem`, etc)
16+
- `WBSTACK_CONTACT_MAIL_SENDER` - The mail address of the sender address of the contact page mails. If the address includes the placeholder `<subject>`, it gets replaced with a shorthand for the actual selected subject (`give-feedback`, `report-a-problem`, etc)
2017

2118
- `WBSTACK_CONTACT_MAIL_RECIPIENT` - The receiver address of the contact page mails
2219

2320
## Developing
2421

2522
### Install dependencies
2623

27-
It is recommened to install the php dependencies via a composer docker container as that contains the required php extensions:
24+
It is recommended to install the php dependencies via a composer docker container as that contains the required php extensions:
2825
```
2926
docker run --rm -it -v $PWD:/app -u $(id -u):$(id -g) composer install --ignore-platform-reqs
3027
```
@@ -85,7 +82,7 @@ If you want to develop with the UI then simply point the UI docker compose setup
8582

8683
### Seeded data
8784

88-
Some data is added to the database via the laraval seeders.
85+
Some data is added to the database via the Laravel seeders.
8986

9087
You can log in with these details for example.
9188

0 commit comments

Comments
 (0)