Development

Setup Development Environment

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

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

Prerequisites:

• RVM
• NVM
• Yarn

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"

Ember Frontend

Navigate to the frontend folder and install dependencies:

cd frontend

yarn install

Start the ember server:

yarn start

---

Development Process

Before a Pull Request

1. Write tests (TDD)
2. Implementation
3. Remove all console outputs
4. Remove unnecessary comments
5. Remove or translate German comments
6. Remove dead code
7. Run Rubocop (code style check) rake rubocop
8. Run all Tests rake
9. Manual testing ok?
10. Update CHANGELOG.md
11. Comply with Git Workflow (Commit/Push/Rebase)
12. Travis CI green?

Before Release

1. Check CHANGELOG.md
2. Check VERSION.md
3. Tag the new release with git tag ...
4. Merge into stable branch
5. Update VERSION.md on master branch