README.md 2.84 KB
Newer Older
1
# AOZ Voluntary Platform
Kaspar Vollenweider's avatar
Kaspar Vollenweider committed
2

3 4 5 6
## Pipeline Status

- Develop: [![pipeline status](https://git.panter.ch/open-source/aoz-003/badges/develop/pipeline.svg)](https://git.panter.ch/open-source/aoz-003/commits/develop)
- Master: [![pipeline status](https://git.panter.ch/open-source/aoz-003/badges/master/pipeline.svg)](https://git.panter.ch/open-source/aoz-003/commits/master)
Kaspar's avatar
Kaspar committed
7

8
Ruby version: 2.4.2
Kaspar Vollenweider's avatar
Kaspar Vollenweider committed
9

10 11
## Table of content

12 13 14 15 16 17 18 19 20 21 22 23
- [AOZ Voluntary Platform](#aoz-voluntary-platform)
  - [Pipeline Status](#pipeline-status)
  - [Table of content](#table-of-content)
    - [Dependencies](#dependencies)
    - [Developer Dependencies](#developer-dependencies)
    - [User seeds for development](#user-seeds-for-development)
    - [Create initial superadmin account](#create-initial-superadmin-account)
    - [Sort locale yaml files](#sort-locale-yaml-files)
    - [Importing from access db with rake task](#importing-from-access-db-with-rake-task)
    - [Run model, integration and controller tests](#run-model-integration-and-controller-tests)
    - [Run system (acceptance) tests](#run-system-acceptance-tests)
    - [LICENSE](#license)
24 25

### Dependencies
Kaspar Vollenweider's avatar
Kaspar Vollenweider committed
26 27

- Postgresql
28
- [ImageMagick](http://www.imagemagick.org/) (for [paperclip](https://github.com/thoughtbot/paperclip))
29

30
### Developer Dependencies
31 32 33 34

- [overcommit](https://github.com/brigade/overcommit)
- [rubocop](https://github.com/bbatsov/rubocop)

35
### User seeds for development
36

37
Use `rails db:seed` to get these users:
Tugce Nur Tas's avatar
Tugce Nur Tas committed
38

39 40 41 42 43 44
- superadmin
  - email: superadmin@example.com
  - password: asdfasdf
- social_worker
  - email: social_worker@example.com
  - password: asdfasdf
Chrysanthi Lagodimou's avatar
Chrysanthi Lagodimou committed
45 46 47
- department_manager
  - email: department_manager@example.com
  - password: asdfasdf
Chrysanthi Lagodimou's avatar
Chrysanthi Lagodimou committed
48 49 50
- volunteer
  - email: volunteer@example.com
  - password: asdfasdf
Tugce Nur Tas's avatar
Tugce Nur Tas committed
51

52 53
### Create initial superadmin account

Kaspar Vollenweider's avatar
Kaspar Vollenweider committed
54
Sends an invitation email to the email address, so that the account can be activated:
55 56 57 58 59 60 61 62 63 64 65 66 67 68

```bash
$  rails setup:superadmin email=email@test.com
```

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

**Only use this on testing servers that are unable to send emails (_security risk_)**

```bash
$  rails setup:superadmin_initialized email=email@test.com
```

### Sort locale yaml files
69 70 71

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

72 73 74 75 76 77 78 79 80 81
```bash
$  rails i18n:sort
```

### Importing from access db with rake task

Run in the command line:

```bash
$  rails access:import file=path/to/access_file.accdb
82 83
```

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
### Run model, integration and controller tests

```bash
$ rails test
```

### Run system (acceptance) tests

For system (acceptance) tests run:

```bash
$ rails test:system
```

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

```bash
$ rails test:system driver=visible
```

104
### LICENSE
105

Tugce Nur Tas's avatar
Tugce Nur Tas committed
106 107
All the sources created are made available under the terms
of the GNU Affero General Public License (GNU AGPLv3).
108
See the GNU-AGPL-3.0.txt file for more details.