Viot

Viot is a project aimed at practicing the development of an IoT application.

Technologies and frameworks

• Python 3.11
• FastAPI
• Celery
• Pytest
• Testcontainers
• EMQX MQTT
• TimescaleDB
• Redis
• Github Actions

Architecture

Getting started

1. Clone the repository

2. Add the following records to your /etc/hosts file:

   127.0.0.1 api.viot.local
   127.0.0.1 flower
   127.0.0.1 mailpit
   127.0.0.1 emqx
   

3. Go to the project directory and run the following command to start the application:

   docker compose up -d
   

4. Run the following command to migrate the database:

   chmod +x ./scripts/migrate.sh
   ./scripts/migrate.sh
   

5. The application should now be running and accessible at:

• API: http://api.viot.local/docs (Swagger UI)
• Celery Flower: http://flower/ (Account login: admin/admin)
• Mailpit: http://mailpit/ (Account login: admin/admin)
• EMQX: http://emqx/ (Account login: admin/admin)

Documentation

Development

See DEVELOPMENT.md for details.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.