Zencrepes

Agile analytics and management across GitHub organizations & repositories made easy!

This repository contains the codebase for the serverless version of ZenCrepes available at ZenCrepes.io, you can find the other codebases at https://github.com/zencrepes

Documentation

You can find ZenCrepes documentation on docs.zencrepes.io, issues should be created here.

This readme only contains developer-focused details.

Reach-out

Feel free to reach out on slack, ZenCrepes has a dedicated channel on #app_zencrepes.

Overture gracefully provides the VM instance hosting dev & prod and the slack channel. ZenCrepes is not an Overture project.

Develop

ZenCrepes is just at the beginning of its adventure, and contributions guidelines will evolve over time.

Develop on ZenCrepes locally.

The instructions below are going to be for Mac but should be very similar to other environments.

Fork and Clone ZenCrepes repository

In GitHub, create a fork of ZenCrepes' repository into your own profile.

Once done, clone the forked repository locally (replace the URL below with your fork).

git clone [email protected]:Fgerthoffert/zencrepes.git

Install dependencies

Once done, cd into the repo's directory and install the required dependencies.

# Download and install Meteor
curl https://install.meteor.com | /bin/sh
# Install the dependencies
meteor npm install

And that should be it.

Register the app in GitHub.

Next, you need to register your app in GitHub to be able to log-in during your testing.

Open-up GitHub, and navigate to your settings.

Go to Developer Settings and click on New OAuth App.

Pick a name to your app and register it with the following URLs:

You will then be redirected to a screen containing your Client ID and Client Secret.

Modify settings.json

With your favorite editor, open the file settings.json at the root of the repository you just cloned.

{
  "public": {
    "analyticsSettings": {
      "Google Analytics": { "trackingId": "GOOGLE_ANALYTICS" }
    },
    "menus": {}
  },
  "private": {
    "MAIL_URL": "",
    "OAuth": {
      "github": {
        "clientId": "METEOR_GITHUB_CLIENTID",
        "secret": "METEOR_GITHUB_CLIENTSECRET",
        "loginStyle": "popup"
      }
    }
  }
}

Replace METEOR_GITHUB_CLIENTID and METEOR_GITHUB_CLIENTSECRET with the secrets you just obtained.

No need to modify GOOGLE_ANALYTICS, which is just used to provide usage metrics for zencrepes.io and dev.zencrepes.io.

Launch ZenCrepes

Back to your terminal, in the zencrepes directory, just launch meteor with the following command.

# Launch Meteor
meteor --settings settings.json

And that's it, you can now access your local instance of Zencrepes pointing your browser to http://localhost:3000 and start coding.

Deploy ZenCrepes to prod

If you contribute to ZenCrepes, you shouldn't have to worry about this aspect as ZenCrepes was set up to autodeploy to zencrepes.io and dev.zencrepes.io, but if you ever want to deploy your own instance online, you'll find some brief instructions below.

Configuration

It is possible to indicate which top-level menus should be made available to the running app by updating the menu key in settings.json. If the object is empty {}, all menus are shown.

{
  "issues": true,
  "sprints": true,
  "milestones": true,
  "labels": false,
  "settings": true
}

This is useful to make different menus available depending of the environment.

Deployment

The best source of instructions for deploy is actually the .circleci config available here: https://github.com/Fgerthoffert/zencrepes/blob/master/.circleci/config.yml