Skip to content

Commit 04ad6dd

Browse files
committed
update readme
1 parent f3d47f7 commit 04ad6dd

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

templates/app-repo/README.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# app-name
2+
3+
One line blurb about what this application does.
4+
5+
More information about this app.
6+
7+
## Development
8+
9+
### Shell
10+
11+
Always enter the development shell before doing anything else. This will make
12+
sure everyone is using the same version of tools, to avoid any system discrepancies.
13+
14+
Install [Nix](https://github.com/LCOGT/public-wiki/wiki/Install-Nix) if you have
15+
not already.
16+
17+
If you have [direnv](https://github.com/LCOGT/public-wiki/wiki/Install-direnv)
18+
installed, the shell will automatically activate and deactive anytime you change
19+
directories. You may have to grant permissions initially with:
20+
21+
```sh
22+
direnv allow
23+
```
24+
25+
Otherwise, you can manually enter the shell with:
26+
27+
```sh
28+
./develop.sh
29+
```
30+
31+
### Skaffold
32+
33+
Deploy application dependencies:
34+
35+
```sh
36+
skaffold -m <app>-deps run
37+
```
38+
39+
Start application development loop:
40+
41+
```sh
42+
skaffold -m <app> dev
43+
```
44+
45+
If there are any Ingresses, they should be exposed at:
46+
- http://<app>.local.lco.earth

0 commit comments

Comments
 (0)