oliver-be / cookiecutter-empirical-project

A template for creating a new Empirical-based project

Cookiecutter Empirical Project

Cookiecutter template for an Empirical Project.

• GitHub repo: https://github.com/devosoft/cookiecutter-empirical-project/
• Free software: MIT LICENSE

An offshoot of the Empirical C++ Library.

Features

• Travis-CI: Ready for Travis Continuous Integration testing.
• Github Pages: Auto-deploy your web application (like this).
• Sphinx docs: Documentation ready for generation and deployment with, for example, ReadTheDocs.
• Bumpversion: Pre-configured version bumping with a single command.

Quickstart

Install the latest Cookiecutter if you haven't installed it yet::

pip install -U cookiecutter

Generate an Empirical project:

cookiecutter https://github.com/devosoft/cookiecutter-empirical-project.git

Get set up a repo on Github & make some git goodness happen:

cd your-cut-project
git init
git add .
git submodule add https://github.com/philsquared/Catch.git third-party/Catch
git submodule add -b master https://github.com/devosoft/Empirical.git third-party/Empirical
git commit -m "Initial commit"
git submodule init
git submodule update
git remote add origin [email protected]:yourusername/your-cut-project.git
git push origin master

‼️ Want to track a particular Empirical commit instead of the master branch? Just omit -b master above.

Take it for a spin!

make test

Then:

• If you haven't already, link your GitHub account to Travis CI.
• The repo might start building on Travis automatically, but if it doesn't add it manually.
• To enable automatic GitHub pages deployment, store a secret GithHub access token to the Travis-CI environment variable GH_TOKEN.
  1. Generate a new GitHub personal access token.
  • Select the repo (Full control of private repositories) scope.
  • ‼️ Be sure to keep a copy on hand for the next step!
  2. echo GH_TOKEN=my_github_token | travis encrypt --no-interactive --com --add
  • You'll need Travis-CI's Ruby gem (sudo gem install travis).
  3. git add .travis.yml -m "Add GH_TOKEN var to Travis env" && git push origin master
  4. Once Travis builds, your site should deploy to https://yourusername.github.io/your-cut-project.
  • ℹ️ Travis will push a gh-pages branch to your repo. No touchy. Just leave it be!
  5. (If your page doesn't auto-deploy, you might have to manually activate Github Pages in your repo settings.)
• Canonical reference RE: storing a personal access token on Travis here.
• Add the repo to your ReadTheDocs account + turn on the ReadTheDocs service hook.