Skip to content

Sync Endpoint Web UI is the user interface module for the sync-endpoint server

License

Notifications You must be signed in to change notification settings

odk-x/sync-endpoint-web-ui

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sync Endpoint Web UI

This project is actively maintained

It is part of the ODK-X Android tools suite.

Sync Endpoint Web UI is the user interface module for the sync-endpoint server.

The developer wiki (including release notes) and issues tracker are located under the ODK-X Tool Suite project.

Engage with the community and get technical support on the ODK-X forum

Prerequisites

  • Docker 17.06.1 or newer

Build

to build a docker image directly from the remote repository:

docker build --pull -t odk/sync-web-ui https://github.com/opendatakit/sync-endpoint-web-ui.git

alternatively, if you've cloned the repository to your local computer, nagivate to the directory containing the DockerFile, and use

docker build -t odk/sync-web-ui .

Run

The Web UI must run in conjunction with ODK sync-endpoint. The fastest way to get sync-endpoint set up is through following the build and run instructions of sync-endpoint-default-setup.

Once everything is set and ready, in the sync-endpoint-default-setup directory, run command docker stack deploy -c docker-compose.yml syncldap to deploy all services

To terminate all services and remove the stack, run docker stack rm syncldap followed by docker system prune.

To customize your local setup, please look at docker-compose.yml inside the sync-endpoint-default-setup directory for more details.

Acknowledgements

This is a fork of Benetech's ODK Hamster

How to contribute

If you’re new to ODK-X you can check out the documentation:

Once you’re up and running, you can choose an issue to start working on from here: 

Issues tagged as good first issue should be a good place to start.

Pull requests are welcome, though please submit them against the development branch. We prefer verbose descriptions of the change you are submitting. If you are fixing a bug please provide steps to reproduce it or a link to a an issue that provides that information. If you are submitting a new feature please provide a description of the need or a link to a forum discussion about it.

Links for users

This document is aimed at helping developers and technical contributors. For information on how to get started as a user of ODK-X, see our online documentation, or to learn more about the Open Data Kit project, visit https://odk-x.org.

About

Sync Endpoint Web UI is the user interface module for the sync-endpoint server

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 60.4%
  • HTML 37.5%
  • CSS 1.7%
  • Dockerfile 0.4%