Skip to content

Improve README.md #1039

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
outdooracorn wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −8
Open

Improve README.md #1039

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
> ℹ️ 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
))
>

# WBStack Platform API
## Configuration
The platform API comes in a few different flavours that can be toggled using environment variables:
Expand All @@ -9,22 +9,19 @@ The platform API comes in a few different flavours that can be toggled using env
- `ROUTES_LOAD_SANDBOX` - web routes for the public facing sandbox usecase
- `ROUTES_LOAD_BACKEND` - internal only API endpoints (non public) for all usecases

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.
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.

## Additional environment variables
### Contact page settings
- `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)
- `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)

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

## Developing

### Install dependencies

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

### Seeded data

Some data is added to the database via the laraval seeders.
Some data is added to the database via the Laravel seeders.

You can log in with these details for example.

Expand Down
Loading