Giter VIP home page Giter VIP logo

caves.app's Introduction

caves.app

Run Django Tests codecov

A Django web application to log caving trips. Running online at caves.app.

Features

  • Complete trip logbook functionality, including rich text trip reports and detailed nerdy stats.
  • Comprehensive granular statistics and graphs of activity.
  • Interactive social features: commenting and 'liking' other's trips, and following other users.
  • The ability to create a public profile, making your trip log available online (if desired).
  • A minimalist and mobile friendly user interface.

Planned

  • Automatically generated maps of caves visited.
  • The ability to upload photos and surveys to trips.
  • An equipment tracking system - keep track of how many batteries you've got left, or how old your rope is!

Contributing

The project is written in Python and Django. Pull requests are more than welcome. Check the GitHub issues for some ideas of what to do.

Development environment

All development is done inside the Docker development environment. To set up the environment, build and run the docker image from the project root directory:

docker-compose up

Once the database has initialised, the server will be accessible at http://127.0.0.1:8000. An initial superuser account with the email address [email protected] and the password admin is created automatically.

Additional test data can be generated using the maketestdata Django management command. You can run the command via docker compose like so:

docker-compose exec web-dev ./manage.py maketestdata

By default, this will create 25 users and 6,000 trips, although this is configurable (see manage.py maketestdata --help for more information). Generation of users and trips may take a few minutes on slower systems. Please note that the maketestdata command can only create users once, as it will attempt to re-use the same sequential emails on the second attempt. If you wish to re-create users, you can stop the Docker instance and delete the data/development directory, before re-initialising the environment:

docker compose down -v
rm -r data/development/
docker compose up

Hints

  • Any emails generated whilst using the development environment will be printed directly to the console.
  • Python requirements are listed in config/requirements/development.txt and can be installed locally (for linting, etc) with pip install -r config/requirements/development.txt.
  • Tests can be run via docker-compose exec web-dev ./manage.py test.

Feedback

Feedback of any kind is more than welcome. Please feel free to open an issue on GitHub, or contact me directly via email at [email protected]. You are also welcome to join the caves.app Discord server to discuss either using the application or development.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.