Skip to content

Commit 30530c9

Browse files
author
John Doe
committed
Add install documentation
1 parent 5070f48 commit 30530c9

File tree

2 files changed

+69
-3
lines changed

2 files changed

+69
-3
lines changed

Dockerfile

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
FROM node:13-alpine
2+
3+
WORKDIR /app
4+
5+
RUN npm install -g --unsafe-perm create-elm-app
6+
7+
EXPOSE 3000
8+
9+
ENTRYPOINT [ "/usr/local/bin/elm-app" ]
10+
11+
# to compile docker run --rm -v $PWD:/app elm-compiler
12+
CMD [ "build" ]

README.md

+57-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,62 @@
1-
# webclient
1+
# Cyberplanning webclient
22

3-
Web calendar in ELM
3+
Web calendar in [ELM lang](https://elm-lang.org/)
44

5-
## Query GraphQL
5+
## Configure
6+
7+
Configuration file is in `src/Config.elm`
8+
9+
## Compile
10+
11+
### Via Docker
12+
13+
Create the image
14+
15+
```
16+
docker build . --tag elm-compiler:latest
17+
```
18+
19+
To build the application with the docker image:
20+
21+
```
22+
docker run --rm -v $PWD:/app elm-compiler
23+
```
24+
25+
This must be executed in the application folder
26+
27+
To start in development mode with server and hot reload:
28+
29+
```
30+
docker run --rm -it -p 3000:3000 -v $PWD:/app elm-compiler start
31+
```
32+
33+
### Via cli
34+
35+
Install `nodejs` using your package manager or [nvm](https://github.com/nvm-sh/nvm)
36+
37+
Install `elm` and `create-elm-app` using `npm`
38+
39+
```
40+
npm install -g elm
41+
npm install -g create-elm-app
42+
```
43+
44+
Compile using [create-elm-app](https://github.com/halfzebra/create-elm-app)
45+
46+
```
47+
elm-app build
48+
```
49+
50+
To start in development mode with server and hot reload:
51+
52+
```
53+
elm-app start
54+
```
55+
56+
57+
## Documentation
58+
59+
### Query GraphQL
660

761
[Cyberplanning API](https://github.com/cyberplanning/apiserver)
862

0 commit comments

Comments
 (0)