ereuse/devicehub-django
8
0
Fork 0
Code Issues 6 Pull requests 6 Packages Projects Releases Wiki Activity

Add improved readme #26

Merged
pedro merged 2 commits from improve-readme into real_main 2024-11-09 20:33:30 +00:00
Conversation 0 Commits 2 Files changed 1 +10 -5
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit d136ae3aa3 - Show all commits

15
README.md
View file

@ -19,15 +19,21 @@ DeviceHub primarily works with three types of objects:
## Installation ## Installation
Assuming a host with debian stable
### Quickstart ### Quickstart
For a quick start with dummy data, DeviceHub can be run directly with docker. To do so, from the root of the project run: For a quick start with dummy data in localhost, DeviceHub can be run directly with docker. To do so, from the root of the project run:
```bash ```bash
./docker-reset.sh ./docker-reset.sh
``` ```
Also there is a demo running in http://demo.ereuse.org/. The token for accessing the instance will be always: `token=5018dd65-9abd-4a62-8896-80f34ac66150`, but the instance will be reset every day a t 4 am. Note that everytime you perform the `docker-reset.sh` script, all data is lost.
Also there is a demo running in http://demo.ereuse.org/. The token for accessing the instance will be always: `token=5018dd65-9abd-4a62-8896-80f34ac66150`, but the instance will be reset every day at 4 am.
For production needs, review and change .env file properly
## Running from baremetal ## Running from baremetal
@ -73,7 +79,7 @@ DOMAIN=localhost
DEBUG=True DEBUG=True
``` ```
Now, expand the enviroment variables: Now, expand the environment variables:
```bash ```bash
source .env source .env
@ -104,7 +110,7 @@ Finally, we can run the DeviceHub service by running:
python manage.py runserver python manage.py runserver
``` ```
## Clean up ### Clean up
To clean up the deployment and start fresh, just delete Django's database: To clean up the deployment and start fresh, just delete Django's database:
@ -112,7 +118,6 @@ To clean up the deployment and start fresh, just delete Django's database:
rm db/* rm db/*
``` ```
## License ## License
DeviceHub is released under the [GNU Affero General Public License v3.0](LICENSE). DeviceHub is released under the [GNU Affero General Public License v3.0](LICENSE).