You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,17 +3,15 @@
3
3
Web app for displaying substitute teachers. This app runs in teacher room in our
4
4
school on Raspberry Pi with a touchscreen attached.
5
5
6
-
## Development
6
+
## Contributing
7
7
8
-
We use Dockerfor development.
8
+
You will need to have [Docker](https://www.docker.com/get-started) installed and `make`for running snippets from `Makefile`.
9
9
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`.
15
13
16
-
For more snippets type `make help`
14
+
For more snippets type `make help` or view the `Makefile`.
0 commit comments