Development

Jump to bottom Edit New page

Sgilgen edited this page Apr 14, 2020 · 33 revisions

Setup Development Environment

Install the database and dependencies using this command (Ubuntu):

sudo apt-get install sqlite3 mysql-client libmysqlclient-dev libqtwebkit-dev

Prerequisites:

Install Ruby, Ruby-Bundler and Node:

rvm install 2.5

gem install bundler

nvm install 10.13.0

Cryptopus

Go to your target Directory and clone the repository:

git clone git://github.com/puzzle/cryptopus.git

Build Cryptopus with the bundler:

cd cryptopus

bundle install

Create and initialize the database:

rake db:create

rake db:setup

rake geo:fetch

Install Frontend dependencies:

yarn

Start the Rails server:

rails s

Browse to http://localhost:3000 and login with default credentials:

user = "root" and password = "password"

Development Process

Before a Pull Request

Write tests (TDD)
Implementation
Remove all console outputs
Remove unnecessary comments
Remove or translate German comments
Remove dead code
Run Rubocop (code style check) rake rubocop
Run all Tests rake
Manual testing ok?
Update CHANGELOG.md
Comply with Git Workflow (Commit/Push/Rebase)
Travis CI green?

Before Release

Check CHANGELOG.md
Check VERSION.md
Tag the new release with git tag ...
Merge into stable branch
Update VERSION.md on master branch