Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tagip/forest-guard
Forest Guard is a [Taiga](https://taiga.io/) dashboard for managers to see who is doing what on their different Taiga projects.
https://github.com/tagip/forest-guard
admin-on-rest dashboard react taiga
Last synced: 3 months ago
JSON representation
Forest Guard is a [Taiga](https://taiga.io/) dashboard for managers to see who is doing what on their different Taiga projects.
- Host: GitHub
- URL: https://github.com/tagip/forest-guard
- Owner: tagip
- Created: 2017-05-26T13:42:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-06T12:20:28.000Z (over 7 years ago)
- Last Synced: 2024-08-01T12:33:23.601Z (6 months ago)
- Topics: admin-on-rest, dashboard, react, taiga
- Language: JavaScript
- Size: 402 KB
- Stars: 26
- Watchers: 6
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - tagip/forest-guard - Forest Guard is a [Taiga](https://taiga.io/) dashboard for managers to see who is doing what on their different Taiga projects. (react)
README
Forest Guard is a [Taiga](https://taiga.io/) dashboard where managers (and any logged user) can see what their teammates are working on (tasks and issues). It is built using the great [admin-on-rest](https://marmelab.com/admin-on-rest/) framework.
The main view is a grid list of users and their assigned tasks and issues that are not closed yet.
## Start the project
### Using yarn
You need to have yarn installed on your computer. First, install dependencies with
```
$ yarn install
```
Then you are ready to run the project using
```
$ yarn start
````
If you have a custom Taiga instance, set `REACT_APP_API_URL` and `REACT_APP_API_URL` variables as you start the project or place them in a `.env` file:
```
$ REACT_APP_BASE_URL=http://taiga.tag-ip.com REACT_APP_API_URL=http://taiga.tag-ip.com/api/v1 yarn start
```
### Using docker
Build the docker image with
```
$ docker build -t forest-guard .
```
You can set the `REACT_APP_API_URL` and `REACT_APP_API_URL` variables if needed using
```
$ docker build --build-arg REACT_APP_API_URL=http://taiga.tag-ip.com/api/v1 --build-arg REACT_APP_BASE_URL=http://taiga.tag-ip.com -t forest-guard .
```
Then you run the image (here on port 8056) with
```
$ docker run -p 8056:80 --name forest-guard --rm forest-guard
```
Finally, you can push the image in a registry (either docker hub or a private registry) so it can be used from anywhere else :
```
$ docker tag forest-guard registry.example.org/forest-guard:latest
$ docker push registry.example.org/forest-guard:latest
```
## Environment variables
*Environment variables car be inserted in the `.env` file*
`REACT_APP_API_URL`: The URL for the API root (default to https://api.taiga.io/api/v1)
`REACT_APP_BASE_URL`: The URL of Taiga front-end (default to http://tree.taiga.io/)
`REACT_APP_DUE_DATE_CUSTOM_ATTRIBUTES`: A JSON object that describes custom attributes used as due date field. The structure of the object is like so:
```
{
PROJECT_X_ID: {
'issue': CUSTOM_FIELD_X_ID,
'task': ANOTHER_CUSTOM_FIELD_X_ID
},
PROJECT_Y_ID: {
'issue': CUSTOM_FIELD_X_ID,
'task': ANOTHER_CUSTOM_FIELD_X_ID
},
// ...
}
```
`REACT_APP_ISSUE_STATUS_FILTER`: A comma separated list of issue status ID used as filter.
`REACT_APP_TASK_STATUS_FILTER`: A comma separated list of task status ID used as filter.
`REACT_APP_IGNORE_USERS`: A comma separated list of user ID that shouldn't be displayed.