Ready to hack on your site? Here's a quick overview.
After installing Go and Node.js, run the following commands to build, configure, and run the application.
go install github.com/writefreely/writefreely/cmd/writefreely@latest
cd $GOPATH/pkg/mod/github.com/writefreely/writefreely@*
make build # Compile the application
make install # Config, generate keys, setup database, install LESS compiler
make run # Run the application
Use the following steps to build WriteFreely without Make. First, get the code:
git clone https://github.com/writefreely/writefreely.git
cd writefreely
Finally, build the writefreely binary with SQLite support. (Remove -tags='sqlite' if you don't need SQLite support.)
go build -v -tags='sqlite' ./cmd/writefreely/
You can now run WriteFreely! But you'll need one more step to generate some assets and successfully run an instance.
You'll need Node.js and LESS installed to generate WriteFreely static assets. Install LESS using our utility script:
./less/install-less.sh
Next, compile all stylesheets from the less directory, creating them in the static/css/ directory:
cd less
CSSDIR=../static/css
lessc app.less --clean-css="--s1 --advanced" ${CSSDIR}/write.css
lessc fonts.less --clean-css="--s1 --advanced" ${CSSDIR}/fonts.css
lessc icons.less --clean-css="--s1 --advanced" ${CSSDIR}/icons.css
lessc prose.less --clean-css="--s1 --advanced" ${CSSDIR}/prose.css
Finally, build ProseMirror:
cd ../prose
npm install
npm run-script build
Now you can run and distribute WriteFreely! 🎉
Beyond this, you'll initialize your individual instance.
With your build complete, create a configuration file, encryption keys, and initialize your database.
Most users will want the interactive configuration process. Run with:
writefreely config start
For other cases where you only need a blank configuration, you can non-interactively generate config.ini with this command:
writefreely config generate
Generate encryption keys needed for storing user sessions and private data:
writefreely keys generate
With your instance configured for a database, run the following command to create the necessary tables:
writefreely db init
writefreely