Git Product home page Git Product logo

enviromonitorweb's Introduction

Build Status

EnviroMonitorWeb

API and simple web interface for EnviroMonitor project. Powered by Django

EnviroMonitorWeb provides backend API to which your air quality sensors can send data. It also provides monitoring station management, user management and simple frontend to present data. You can use this project to start awareness campaign in you local area.

Development with Docker and docker-compose

You can get this project up and running in a traditional way with virtual environment + postgis config, but it is much easier to run it using docker.

To start development:

  1. install docker and docker-compose
  2. run docker-compose build to build web container
  3. run docker-compose up web to test web and db containers
  4. run docker-compose run web python manage.py migrate to apply migrations
  5. run docker-compose run web python manage.py createsuperuser to create admin account

To run project:

  1. run docker-compose up web
  2. point your browser to localhost:8080
  3. press CTRL+C to stop

Notes:

  1. To run command inside container you can use run entrypoint command. I.e. sudo docker-compose run web py.test -s --cov=. --cov-report=html to run unit tests and check coverage. I.e. sudo docker exec -it enviromonitorweb_db_1 psql -U docker -d docker when you want access to database

API documentaion:

Check http://localhost:8080/api/v1/docs/ to find full REST API documentation.

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.