Skip to content

pyronear/pyro-crowdsourcer

Repository files navigation

License Test Status Codacy Badge CodeFactor

The image crowdsourcing platform for wildfire visual data.

Quick Tour

Running/stopping the service

You can run the platform as a container using this command:

make run

You can now navigate to http://localhost:8050 to interact with the platform.

App screenshot

In order to stop the service, run:

make stop

Installation

Prerequisites

The project was designed so that everything runs with Docker orchestration (standalone virtual environment) that will run itself the Dash interface, so you won't need to install any additional libraries.

Configuration

In order to run the project, you will need to specific some information, which can be done using a .env file. This file will have to hold the following information:

  • API_URL: the endpoint URL of your pyro-storage instance
  • API_LOGIN: the login for your API access
  • API_PWD: the password for your API access

So your .env file should look like something similar to:

API_URL='https://replace.with.your.api.endpoint/'
API_LOGIN=my_dummy_login
API_PWD=my_dummy_password

The file should be placed at the root folder of your local copy of the project.

Contributing

If you scrolled down to this section, you most likely appreciate open source. Do you feel like helping with unresolved issues? Or perhaps submitting a new feature idea? Or contributing in any other way?

You're in luck, we compiled a short guide (cf. CONTRIBUTING) for you to easily do so!

License

Distributed under the Apache 2.0 License. See LICENSE for more information.