File tree 1 file changed +21
-0
lines changed
1 file changed +21
-0
lines changed Original file line number Diff line number Diff line change @@ -24,6 +24,27 @@ can be run as follows:
24
24
./result/bin/simple-ts-clock
25
25
```
26
26
27
+ ## Usage
28
+ 1 . Clone the repository.
29
+ 2 . Navigate to the repository directory.
30
+ 3 . Create a ` .env ` file based on ` .env.example ` .
31
+ 4 . Run ` npm install ` to install dependencies.
32
+
33
+ ### How to use
34
+
35
+ 1 . Run ` npm run start ` to start the npm server or ` npm run watch ` to watch for changes.
36
+ 2 . Navigate the browser to ` locahost:8080 ` or the port specified in the ` .env ` config.
37
+
38
+ ### Offline Mode
39
+
40
+ Offline mode will disable api requests to the server leaving only the clock running. It can be activated by going to ` /offline ` path.
41
+
42
+ ### Demo Mode
43
+ Demo mode works like offline mode but displays demo information instead of real data from apis. It can be activated by going to ` /demo ` path.
44
+
45
+ ### Configuration
46
+ To override the default config, you can use the URL GET parameters or by pressing ` c ` to open the config options.
47
+
27
48
## Deployment
28
49
29
50
To deploy to ACM's clock machine, simply run
You can’t perform that action at this time.
0 commit comments