Shelter Database

Presentation

The goal of this application is to list the shelters deployed around the world.

An instance is available here.

Deployment

Requirements

$ sudo apt-get install postgresql npm

Configure and install the application

Database configuration

$ ./create_db.sh shelter pgsqluser pgsqlpwd

Application

~$ git clone https://github.com/cedricbonhomme/shelter-database
~$ cd shelter-database/
~/shelter-database$ npm install
~/shelter-database$ cp src/conf/conf.cfg-sample src/conf/conf.cfg
~/shelter-database$ poetry install
~/shelter-database$ poetry shell
(shelter-database-p6akjfaH-py3.9) ~/shelter-database$ ./create_db.sh shelter pgsqluser pgsqlpwd
(shelter-database-p6akjfaH-py3.9) ~/shelter-database$ ./init_db.sh
(shelter-database-p6akjfaH-py3.9) ~/shelter-database$ python src/runserver.py
* Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)

Read the documentation for more information about the deployment of the application.

Documentation

To generate the documentation in HTML format:

./documentation$ sudo pip install sphinx
./documentation$ make html

The result will be in the _build folder.

License

This application is under MIT license.

Contact

Cédric Bonhomme