README.md

AOZ Voluntary Platform

master: | develop:

Ruby version: 2.4.2

Table of content

1. Dependencies
2. Developer Dependencies
3. User seeds for development
4. Create initial superadmin account
5. Sort locale yaml files
6. Importing from access db with rake task
7. Run model, integration and controller tests
8. Run system (acceptance) tests
9. LICENSE

Dependencies

• Postgresql
• ImageMagick (for paperclip)

Developer Dependencies

• overcommit
• rubocop

User seeds for development

Use rails db:seed to get these users:

• superadmin
  • email: [email protected]
  • password: asdfasdf
• social_worker
  • email: [email protected]
  • password: asdfasdf
• department_manager
  • email: [email protected]
  • password: asdfasdf
• volunteer
  • email: [email protected]
  • password: asdfasdf

Create initial superadmin account

Sends an invitation email to the email address, so that the account can be activated:

$  rails setup:superadmin [email protected]

Ready to use with standard Password asdfasdf (No activation needed):

Only use this on testing servers that are unable to send emails (security risk)

$  rails setup:superadmin_initialized [email protected]

Sort locale yaml files

Run this task, in order to sort the locale files alphabetically.

$  rails i18n:sort

Importing from access db with rake task

Run in the command line:

$  rails access:import file=path/to/access_file.accdb

Run model, integration and controller tests

$ rails test

Run system (acceptance) tests

For system (acceptance) tests run:

$ rails test:system

For having chrome open and visible when running system tests locally:

$ rails test:system driver=visible

LICENSE

All the sources created are made available under the terms of the GNU Affero General Public License (GNU AGPLv3). See the GNU-AGPL-3.0.txt file for more details.