Search…
Technical overview
Repository
Apps
Libs
Reference
GitBook Template
Here is a simple template for the README of your project:
1
# Project name
2
3
## About
4
5
[Introduction about the project and its purpose]
6
7
## URLs
8
9
- [Dev](https://beta.dev01.devland.is)
10
- [Staging](https://beta.staging01.devland.is)
11
- [Production](https://island.is)
12
13
## API
14
15
To run the api
16
17
```bash
18
yarn start api
19
```
20
21
To build the production bundle
22
23
```bash
24
yarn build api --prod
25
```
26
27
## Web
28
29
To run the dev server
30
31
```bash
32
yarn start web
33
```
34
35
## Etc...
36
37
## Project owner
38
39
[If any entity is owning the project e.g.]
40
41
- [Vegagerðin](http://www.vegagerdin.is)
42
43
## Code owners and maintainers
44
45
[Github team in the island.is organisation or individuals e.g.]
46
47
- [Aranja](https://github.com/orgs/island-is/teams/aranja/members)
Copied!
Copy link