Skip to content

Commit a51e2d5

Browse files
authored
Merge pull request #62 from zsk-poznan/contributing-guideline
Add contributing guide
2 parents efe0250 + db14b14 commit a51e2d5

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,15 @@
33
Web app for displaying substitute teachers. This app runs in teacher room in our
44
school on Raspberry Pi with a touchscreen attached.
55

6-
## Development
6+
## Contributing
77

8-
We use Docker for development.
8+
You will need to have [Docker](https://www.docker.com/get-started) installed and `make` for running snippets from `Makefile`.
99

10-
```sh
11-
make start # For starting the containers, you can access the site on http://localhost:5000
12-
make logs # To show the logs
13-
make stop # To stop all the containers
14-
```
10+
You can run `make start logs` to start the application in development mode. This could take a while since it ensures all dependencies are installed. After that, you should be able to visit the app on http://localhost:3000. The hot reloading is enabled.
11+
12+
To stop the app run `make stop`.
1513

16-
For more snippets type `make help`
14+
For more snippets type `make help` or view the `Makefile`.
1715

1816
## Deploy
1917

0 commit comments

Comments
 (0)