https://github.com/fan9704/petmonitoringsystem-backend
Use Django Develop Elastic Stack Pet Monitoring System
https://github.com/fan9704/petmonitoringsystem-backend
django django-rest-framework elasticsearch elasticstack kibana pika postgresql rabbitmq
Last synced: 6 months ago
JSON representation
Use Django Develop Elastic Stack Pet Monitoring System
- Host: GitHub
- URL: https://github.com/fan9704/petmonitoringsystem-backend
- Owner: fan9704
- License: other
- Created: 2023-01-18T17:35:40.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-01T08:23:32.000Z (almost 2 years ago)
- Last Synced: 2025-04-12T01:52:03.501Z (6 months ago)
- Topics: django, django-rest-framework, elasticsearch, elasticstack, kibana, pika, postgresql, rabbitmq
- Language: Python
- Homepage:
- Size: 4.36 MB
- Stars: 6
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
- Contributing: CONTRIBUTING.MD
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Pet Monitoring Backend
## System Structure
## Software Development Lifecycle
---
[Swagger Route](http://127.0.0.1:8000/swagger/)
[Django System Check](http://127.0.0.1:8000/health/)
[Rabbit Console](http://127.0.0.1:15672/)
[SonarQube Console](http://127.0.0.1:9000/)
[Forest Admin](https://app.forestadmin.com/)
## Setup Project
### Step.1 Install Dependencies with pipenv
```shell
pipenv install
```
### Step.2 Construct Environments with Docker-compose
```shell
docker-compose up
```
### Step.3 Environment Variables .env Setup
.env file
Please refer .env.example
```dotenv
#Django
DJANGO_SECRET_KEY =
DEBUG =
#Elasticsearch
ELASTICSEARCH_ENDPOINT =
#PostgreSQL
POSTGRES_DB =
POSTGRES_USER =
POSTGRES_PASSWORD =
POSTGRES_DB_URL =
#ChatGPT
CHATGPT_APIKEY =
#RabbitMQ
RABBITMQ_ENABLE =
RABBITMQ_USERNAME =
RABBITMQ_PASSWORD =
RABBITMQ_SERVER_IP =
RABBITMQ_PORT =
RABBITMQ_VIRTUAL_HOST =
#Celery
BROKER_URL =
#Redis
REDIS_URL=
...
```
### Step.4 Migrate Schema to PostgreSQL
```shell
pipenv run python manage.py migrate
```
### Step.5 Migrate Index to Elasticsearch(django-elasticsearch-dsl)
```shell
pipenv run python manage.py search_index --create
pipenv run python manage.py search_index --populate --refresh
```
### Step.6 Runserver
```shell
pipenv run python manage.py runserver 0.0.0.0:8000
```
### Step.7 Run Commands
```shell
pipenv run python manage.py MQTTListener
```
----
## Other
### Install Dependencies with venv
#### Create venv
```shell
python -m venv .
```
#### Activate venv
```shell
Scripts/activate
```
#### Deactivate venv
```shell
Scripts/deactivate
```
#### Install from requirements.txt
```shell
pip install -r requirements.txt
```
#### Freeze dependencies
```shell
pip freeze > requirements.txt
```
### Run Integration Test
```shell
python manage.py test PetMonitoringSystemBackend.test [--verbosity 2]# Unit Test --verbosity 2 is output detail
python manage.py test api.tests.unit [--verbosity 2]# Unit Test --verbosity 2 is output detail
python manage.py test api.tests.integration #Intergration Test
python manage.py test #All Test
```
### Run with ASGI
```shell
daphne -b 0.0.0.0 -p 8000 PetMonitoringSystemBackend.asgi:application
```