Add development setup guide

This commit is contained in:
Matt Baer 2019-04-16 11:06:26 -04:00
parent 6458092283
commit 8ce0a3d959

24
developer/setup.md Normal file
View File

@ -0,0 +1,24 @@
# Development Setup
Ready to hack on your site? Here's a quick overview.
## Prerequisites
* [Go 1.10+](https://golang.org/dl/)
* [Node.js](https://nodejs.org/en/download/)
## Setting up
Run these commands to get set up.
```bash
go get -d github.com/writeas/writefreely/cmd/writefreely
# If running Go 1.11+
export GO111MODULE=on
make build # Compile the application
./cmd/writefreely/writefreely --config # Create configuration file
make install # Generates encryption keys; installs LESS compiler
make run # Runs the application
```