Skip to content

Commit 1424026

Browse files
author
m.hollink
committed
Add more information about contributions to the README
1 parent fa37b17 commit 1424026

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,31 @@ We welcome any and all contributions! Here are some ways you can get started:
4646
4. Commit and push
4747
5. Submit a pull request
4848
6. Wait for pull request to be merged
49+
50+
## Running the project locally
51+
52+
The application is build up into 3 main parts; The webapp, an API and a database. Each of these component can be run
53+
locally which allows you to make some changes and test these before commiting / submitting a pull request.
54+
55+
### The API & Database
56+
57+
The API and database can be started locally using [Docker](https://www.docker.com/). There is a Dockerfile inside
58+
the /api folder which can be used to create an image containing the required environment to run the Slim4 API. Since the
59+
API is connecting to a database and a connection is required between its easier to spin everything up using
60+
docker compose.
61+
62+
```shell
63+
# from the root directory:
64+
docker compose up
65+
```
66+
67+
> Note: Running the api container automatically creates/overwrites your .env file with the local database credentials.
68+
69+
#### API Client
70+
71+
After the containers are started you can open up an API client like [Postman](https://www.postman.com/)
72+
or [Thunder Client](https://www.thunderclient.com/). There is a postman collection in the repository you can
73+
use if you decide on using Postman.
74+
75+
> Note: Each request must have an Authorization header consisting a bearer token. For development, it's not necessary to
76+
> have a valid token (as its being mocked in the [$tokenMiddleware](./api/src/middleware/token-verification.php)).

0 commit comments

Comments
 (0)