- Redis
- Panter Controllr
- Github
- Gitlab
-
Install ruby (
rbenvrecommended) -
Install redis
-
cp .env.example .envand fill in some values (esp. the access tokens) -
rake clone_git_repositoriesto have all git repositories locally. alternatively you can rsync the cloned repositories from the production server. -
rails sThe server will fetch all data for all modules by default. To only load certain modules the environment variable
MODULEScan be used.Example 1, only load controllr data
MODULES=controllr rails sExample 2, skip all data fetching altogether (useful when you already have data fetched previously and want to quickly start the server)
MODULES= rails sExample 3, fetch git and controllr data
MODULES=controllr,git rails s
Whenever an endpoint is updated or a new one is added the swagger docs need to be updated as well. ZRO: OpenApi 3 JSON-Doc Generator for Rails is used for this.
After updating the definition in the respective controller the task rake doc
generates the Swagger definition in public/api.json. This file should be
checked in to Git as well.
Licensed under the GNU Affero General Public License v3.0
Copyright 2016 Panter AG <[email protected]>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
