Skip to content

Commit 706545a

Browse files
committed
improve development readme section
1 parent 7be16c6 commit 706545a

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# Welcome! [![Build Status](https://travis-ci.org/ccbrown/gggtracker.svg?branch=master)](https://travis-ci.org/ccbrown/gggtracker)
22

3-
This is the repository for <a href="https://gggtracker.com" target="_blank">gggtracker.com</a>. If there's something you think the site is missing, please either a.) open an issue to request the feature or b.) develop the feature yourself and put in a pull request. Pull requests should be written in the same style as the existing code base and any new features should be implemented in a way that's as concise and unintrusive as possible. Before creating any pull requests, please run `make pre-commit` to format and test your changes.
3+
This is the repository for <a href="https://gggtracker.com" target="_blank">gggtracker.com</a>. If there's something you think the site is missing, please either a.) open an issue to request the feature or b.) develop the feature yourself and put in a pull request.
44

5-
### Running
5+
### Development
66

7-
If you have Go installed, you can run the server like so: `go get ./... && go run main.go`
7+
If you have Go installed, you can develop and run the server in the usual way: `go get ./... && go run main.go`
88

9-
Or if you just want to run a server using Docker: `docker run -it -p 8080:8080 ccbrown/gggtracker`
9+
![Development](development.gif)
1010

11-
Either method will make a local instance of the tracker available at http://127.0.0.1:8080
11+
The server will only track Reddit by default. To track the forums, you'll need to use the `--forumsession` argument.
12+
13+
Before creating any pull requests, please run `make pre-commit` to format and test your changes.
14+
15+
### Deployment
16+
17+
The easiest way to deploy is using Docker: `docker run -it -p 8080:8080 ccbrown/gggtracker`
1218

1319
### License / Attribution
1420

development.gif

3.32 MB
Loading

0 commit comments

Comments
 (0)