Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/penguineer/actionablesweb

Show actionable items from an Actionables service in the Browser.
https://github.com/penguineer/actionablesweb

gtd productivity

Last synced: about 2 months ago
JSON representation

Show actionable items from an Actionables service in the Browser.

Host: GitHub
URL: https://github.com/penguineer/actionablesweb
Owner: penguineer
Created: 2020-03-10T18:34:18.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-07-19T14:56:42.000Z (over 1 year ago)
Last Synced: 2024-05-02T02:12:34.953Z (9 months ago)
Topics: gtd, productivity
Language: JavaScript
Homepage: https://hub.docker.com/r/mrtux/actionables-web/
Size: 247 KB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 7
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

# Actionables Web

![Docker Image](https://github.com/penguineer/ActionablesWeb/actions/workflows/docker-image.yml/badge.svg)

> Show actionable items from an [Actionables service](https://github.com/penguineer/RedmineActionablesCollector) in the Browser.

## Usage

### Configuration

Configuration is done using environment variables:

* `PORT`: Target port when used with docker-compose (default `8080`)
* `ACTIONABLES_URL` URL to the actionables collector service, e.g. [Redmine Actionables](https://github.com/penguineer/RedmineActionablesCollector)

### Run with Docker

```bash
docker run --rm -it \
-p 8080:8080 \
-e ACTIONABLES_URL="" \
mrtux/actionables-web
```

### Run with Docker-Compose (Development)

To run with [docker-compose](https://docs.docker.com/compose/) copy [`.env.template`](.env.template) to `.env` and edit the necessary variables. Then start with:

```bash
docker-compose up --build
```

Please note that this compose file will rebuild the image based on the repository. This is helpful during development and not intended for production use.

When done, please don't forget to remove the deployment with
```bash
docker-compose down
```

## Maintainers

* Stefan Haun ([@penguineer](https://github.com/penguineer))

## Contributing

PRs are welcome!

If possible, please stick to the following guidelines:

* Keep PRs reasonably small and their scope limited to a feature or module within the code.
* If a large change is planned, it is best to open a feature request issue first, then link subsequent PRs to this issue, so that the PRs move the code towards the intended feature.

## License