mirror of https://github.com/statping/statping
Updated Makefile (markdown)
parent
aef858aaa2
commit
ca92c3f164
53
Makefile.md
53
Makefile.md
|
@ -1,29 +1,34 @@
|
|||
Here's a simple list of Makefile commands you can run using `make`. The [Makefile](https://github.com/statping/statping/blob/master/Makefile) may change often, so i'll try to keep this Wiki up-to-date.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/statping/statping/blob/master/Makefile">View Makefile</a>
|
||||
</p>
|
||||
|
||||
# Useful Commands
|
||||
- `make clean` - Cleans the Statping directory for a fresh start
|
||||
- `make test-deps` - Installs required golang libraries for compiling and building
|
||||
|
||||
# Building
|
||||
- `make build` - Build the golang Statping binary for native OS
|
||||
- `make compile` - Compiles the production frontend Vue
|
||||
- `make build-all` - Cleans, compiles, and builds all binaries
|
||||
- `make build-linux` - Builds Linux binaries
|
||||
- `make build-mac` - Builds MacOSX binaries
|
||||
- `make build-win` - Builds Windows binaries
|
||||
|
||||
# Testing
|
||||
- `make test` - Cleans, compiles and runs golang unit testing
|
||||
- `make test-api` - Test postman API endpoints
|
||||
- `make test-cli` - Test that run on Github Actions using `sqlite`
|
||||
|
||||
# Docker
|
||||
- `make docker-latest` - Builds the `base` and `latest` Statping images
|
||||
- `make start` - Run the entire Statping stack with multiple databases and Grafana
|
||||
- `make stop` - Stop the entire Statping stack
|
||||
- `make lite` - Run a lite Statping stack that includes Postgres
|
||||
|
||||
# Required System Libraries
|
||||
- Ubuntu `apt-get install build-essential`
|
||||
- MacOSX `sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer`
|
||||
- Windows [Install Guide for GNU make utility](http://gnuwin32.sourceforge.net/packages/make.htm)
|
||||
- CentOS/RedHat `yum groupinstall "Development Tools"`
|
||||
|
||||
### Commands
|
||||
```bash
|
||||
make build # build the binary
|
||||
make install
|
||||
make run
|
||||
make test
|
||||
make coverage
|
||||
make docs
|
||||
# Building Statping
|
||||
make build-all
|
||||
make build-alpine
|
||||
make docker
|
||||
make docker-run
|
||||
make docker-dev
|
||||
make docker-run-dev
|
||||
make databases
|
||||
make dev-deps
|
||||
make clean
|
||||
make compress
|
||||
make cypress-install
|
||||
make cypress-test
|
||||
```
|
||||
- CentOS/RedHat `yum groupinstall "Development Tools"`
|
Loading…
Reference in New Issue