https://github.com/fieldpapers/fp-tasks

Field Papers offline task server
https://github.com/fieldpapers/fp-tasks

fieldpapers hacktoberfest openstreetmap python

Last synced: 14 days ago
JSON representation

Field Papers offline task server

• Host: GitHub
• URL: https://github.com/fieldpapers/fp-tasks
• Owner: fieldpapers
• Created: 2015-05-17T06:27:57.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2023-07-10T17:43:44.000Z (over 1 year ago)
• Last Synced: 2024-06-19T09:40:27.160Z (6 months ago)
• Topics: fieldpapers, hacktoberfest, openstreetmap, python
• Language: Python
• Homepage:
• Size: 14 MB
• Stars: 4
• Watchers: 5
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md

Awesome Lists containing this project

README

        
# fp-tasks

## Running

This is intended to be run from a Docker image. `-v $(pwd):/app` facilitates

local development, `--env-file` propagates environment variables into the

container.  See `.env.sample` for sample `.env` file.

```bash

docker run --rm \

  -p 8080:8080 \

  -v $(pwd):/app \

  --env-file .env \

  fieldpapers/tasks

```

## Environment variables

* `AWS_REGION` - AWS region. Required if using S3.

* `S3_BUCKET_NAME` - S3 bucket name. Required if using S3.

* `AWS_ACCESS_KEY_ID` - AWS key with read/write access to the configured S3

  bucket(s).

* `AWS_SECRET_ACCESS_KEY` - Corresponding secret.

* `API_BASE_URL` - Base Field Papers API URL (used when generating QR codes and

  titles). Defaults to `https://fieldpapers.org/`.

* `PERSIST` - File persistence. Can be `local` or `s3`. Defaults to `s3`.

* `STATIC_PATH` - Path to write static files to. Must be HTTP-accessible for

  page merging to work. Required if using `local` persistence.

* `STATIC_URI_PREFIX` - Prefix to apply to static paths (e.g.

  http://example.org/path) to allow them to resolve. Required if using `local`

  persistence.

## Quick links

- [🔗 fieldpapers.org](https://fieldpapers.org)

- [📋 Project overview](https://github.com/fieldpapers)

- [🐞 Issues and bug reports](https://github.com/fieldpapers/fieldpapers/issues)

- [🌐 Translations](https://explore.transifex.com/fieldpapers/fieldpapers/)

- [🤝 Code of Conduct](https://wiki.openstreetmap.org/wiki/Foundation/Local_Chapters/United_States/Code_of_Conduct_Committee/OSM_US_Code_of_Conduct)