This is the source for the Swedish Trifork Website. You are welcome to copy or get inspired by it. We have a MIT license on it see the LICENSE file.
-
Run these commands and you will be up and running:
make setup make run # Open your browser on http://localhost:9090/
-
Some setgulpto your
.bashrc
,.zshrc
or.profile
depending on your setup:export TF_MEETUP_API_KEY="[...]" # Where [...] is our API key from meetup.com export TF_RECAPTCHA_SECRET_KEY="[...]" # Where [...] is our recaptcha key from google.com export TF_MANDRILL_API_KEY_="[...]" # Where [...] is our mandrill API key. export TF_ENV="dev" # Use a developer setup, not production.
Compilation of our handbook is handled a little specially. Since we cannot compile the handbook into
all the formats required on deployment, we have to check all the formatted versions in as well.
To ensure the different version are never out of sync with the master file (e.i. handbook.md
) a git
hook enforces that the handbook.{ext} must be newer than handbook.md
.
During development a gulp
task will ensure that they are always in sync. But if you change the
handbook while not running the server, you can explicitly update them using:
gulp handbook
This mostly applies to Trifork employees, but everyone is welcome to contribute. Just send a pull-request here on GitHub -- that's it.
The make setup
script will install a Heroku git-remote. When the project is pushed to it
the website is deployed. You will have to be granted push-permission to the repo by our
heroku account. There is a nifty make target for deploying, just write:
make deploy