This is the open-source server software for gping.io.
The client (Android app) may be downloaded at Google Play.
If you're interested in running your own dev server we've tried to make setup as simple as possible by providing a set of containers. These collect all necessary configuration for local development and should make it trivial to get a functional production deployment.
For more detailed discussion of our container setup see docker/README.md. In summary, however, to get a dev environment running:
- Clone this repo
- Define
GPINGIO_HOME
to be the cloned directory $GPINGIO_HOME> ./docker/build.sh
$GPINGIO_HOME> ./docker/db.sh
$GPINGIO_HOME> ./docker/www.sh
You should now have an instance of the latest build running on localhost:8080
.
A brief discussion of the helper scripts used is here. If you're
interested in running a production instance see this for the changes
that shourd be made.
If you already have production Apache server ready to serve PHP files, you can
always deploy the www/
directly under your htdocs. Don't forget to a2enmod rewrite
in order to enable the one Apache module needed for gping.io.
Our community guidelines are outlined in the code of conduct.
- Roadmap—Where we see GPing going and the large blocks of work that needs attention next.
- Issues List—actionable tasks that need to be completed to reach some goal on our roadmap.
- Forum—Ask questions to the community.
We also try to idle in the #gping.io
IRC channel on Freenode.
Components of the project live loosely coupled under $GPING_HOME
with
related code grouped by directory.
db
—DB schema and sample datadocker
—container definitions and helper scripts around running dev setupdocs
—various documentation; each major topic coordinated undertopic.md
test
—test code; not included in the deployed build but mounted in the dev containerwww
—website & backend; additional discussion in www docs