coop-cloud-chaos-patchs
/
go-ssb-room
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update contribution guideline for style css

This commit is contained in:
Henry 2021-05-19 12:17:37 +02:00
parent 6ef69724e7
commit de21fdde40
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -22,6 +22,8 @@ For an architecture and instructions on setting up a webserver to use with `go-s
## Development
(_TODO: move this section to contributing document_ See: https://github.com/ssb-ngi-pointer/go-ssb-room/issues/206 )
To get started, you need a recent version of [Go](https://golang.org). v1.16 and onward should be sufficient.
To build the server and see a list of its options:
@ -71,16 +73,19 @@ This can be useful if you are working on:
* html templates,
* styling elements using [tailwind](https://tailwindcss.com/docs/)
* _if you don't run generate with `-tags dev`, the bundled css will only contain the tailwind classes found in *.tmpl at the time of generation!_
* or website assets
* or website templates or assets like JavaScript files, the favicon or other images that are used inside the HTML.
This way, the build won't use the assets embedded in the binary, but instead read them directly from the local filesystem.
Once you are done with your changes and want to update the embedded assets:
Once you are done with your changes and want to update the embedded assets to the production versions:
```sh
# cd to the root of the folder, and then run go generate
go generate -tags dev ./...
go generate ./...
# now build the server without the development mode
cd cmd/server && go build && ./server -htts-domain my.room.example
```
## Tooling
### Mocks