Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
- default values
- screesnhots
  • Loading branch information
Jérôme Blondon committed Apr 24, 2019
1 parent ddeb8fe commit 9eeba5b
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 14 deletions.
1 change: 1 addition & 0 deletions .meteorignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/*
44 changes: 30 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A project management tool.

![Kanban](/docs/kanban.png)

## Features

- [Kanban](https://en.wikipedia.org/wiki/Kanban_(development)) task board with realtime updates
Expand All @@ -25,24 +27,24 @@ Copy `settings-development.json.sample.json` to `settings-development.json` and

Settings:

| Key | Type | Description
|-----------------------|---------------|--------------------------|
|generateFixtures | boolean | If true, users fixtures are generated at startup |
|disableAccountCreation | boolean | If true account creation is forbidden |
|attachmentsPath | string | Attachment storage path on fs |
|email.from | string | From email when sending mail |
|roles.admin | [string] | Users matching emails will have the admin role |
|public.seo.titlePrefix | string | window.title prefix |
|sso | object | See below |
|uploadTransport | string | http or ddp |
| Key | Type | Default value | Description |
|-----------------------|---------------|--------------------------|--------------------------|
|generateFixtures | boolean | false | If true, users fixtures are generated at startup |
|disableAccountCreation | boolean | false | If true account creation is forbidden |
|attachmentsPath | string | /tmp/ | Attachment storage path on fs |
|email.from | string | noreply@localhost | From email when sending mail |
|roles.admin | [string] | [] | Users matching emails will have the admin role |
|public.seo.titlePrefix | string | l'atelier | window.title prefix |
|sso | object | {} | See below |
|uploadTransport | string | ddp | http or ddp |


sso:

| Key | Type | Description
|-----------------------|---------------|--------------------------|
| enabled | boolean | If true, sso is enabled |
| email | string | email header to match user |
| Key | Type | Default value | Description |
|-----------------------|---------------|--------------------------|----------------------------|
| enabled | boolean | false | If true, sso is enabled |
| email | string | null | email header to match user |


Example:
Expand Down Expand Up @@ -78,6 +80,20 @@ Example:

```npm start```

### Screenshots

![Dashboard](/docs/dashboard.png)

![Planning (organization)](/docs/planning1.png)

![Planning (project)](/docs/planning2.png)

![BPMN](/docs/bpmn.png)

![Weather](/docs/weather.png)

![Canvas](/docs/canvas.png)

### License

Apache License 2.0
Binary file added docs/bpmn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/canvas.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/kanban.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/planning1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/planning2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/weather.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9eeba5b

Please sign in to comment.