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
+19
Original file line number
Diff line number
Diff line change
@@ -38,6 +38,25 @@ Spins up a development server where you can make all your calls, and run it like
38
38
39
39
This will generate a minified and buildable version of the website in the `dist` folder to use on a web server. In order to use history, you must have a proxy enabled, and reverse proxy enabled for the API calls. There is some setup involved, depending on your flavour of web servers, but some setup configs can be found [here](https://github.com/PhlexPlexico/G5V/wiki).
40
40
41
+
### Docker Build Instructions:
42
+
There are 2 dockerfiles included, ```DockerfileLight``` and ```DockerfileFull```.
43
+
44
+
#### DockerfileLight:
45
+
This should be used if yarn is already installed on your local machine.
46
+
To use it, you first need to build the application using ```yarn``` and ```yarn build```. This will create a dist folder.
47
+
From here, run the command ```docker build -t yourname\g5v:latest -f DockerfileLight .```
48
+
Now, you can run your application by running ```docker container run --name g5v -p 80:80 yourname\g5v:latest```
49
+
50
+
#### DockerfileFull:
51
+
This should be used if you do not have yarn, and do not want to install it.
52
+
This file will install yarn in the container, build the application, and execute it.
53
+
To use it, run ```docker build -t yourname\g5v:latest -f DockerfileFull .```
54
+
This can take over a minute to complete.
55
+
Now, you can run your application by running ```docker container run --name g5v -p 80:80 yourname\g5v:latest```
56
+
57
+
Please note that both of the dockerfiles still require G5API to be running on the subfolder /api/.
58
+
Some example setup configs can be found [here](https://github.com/PhlexPlexico/G5V/wiki).
59
+
41
60
## Contribution
42
61
Sure! If you have a knack for APIs and a penchant for JavaScript, I could always use help! Create a fork of this application, make your changes, and submit a PR. I will be using the [Issues](https://github.com/G5V/issues) page to track what calls still need to be completed.
0 commit comments