IoT Device Management

Welcome to the IoT Device Management API! This project provides an API for managing IoT devices, users, and locations. Using aiohttp, Peewee, and PostgreSQL, it supports essential CRUD operations for managing users, devices, and locations.

Project Setup

The app provides several endpoints to manage IoT resources:

• User Endpoints: Create, retrieve, and delete user records.
• Location Endpoints: Manage locations where devices are installed.
• Device Endpoints: Perform operations on IoT devices, including create, update, and delete actions.

---

You can run the project locally or use Docker for containerized deployment. Instructions for both methods are provided below.

Running the Project with Docker

Prerequisites

• Docker: Ensure Docker is installed on your machine. Download it from Docker's official website.
• Docker Compose: Make sure it's installed as well. Installation instructions can be found here.

Getting Started

1. Clone the Repository:

   git clone https://github.com/casual-user-asm/iot_app.git
   cd iot-app

2. Create and Configure .env File:

   • Create a .env file in the root directory with the following content:

   DATABASE_NAME=postgres
   DATABASE_USER=postgres
   DATABASE_PASSWORD=postgres
   DATABASE_HOST=my_database
   DATABASE_PORT=5432
   

   • Ensure PostgreSQL is running and accessible using these credentials.

3. Build the Docker Images:

   docker-compose build

4. Run the Containers:

   docker-compose up -d

Running the Application Locally

1. Clone the Repository:

   git clone https://github.com/casual-user-asm/iot_app.git
   cd iot-app

2. Create and Activate a Virtual Environment:

   python -m venv venv
   # On Linux:
   source venv/bin/activate
   # On Windows:
   venv\Scripts\activate

3. Install Dependencies:

   pip install -r requirements.txt

4. Run the Application:

   python server.py

API Endpoints

User Endpoints

• GET /users: Retrieve a list of all users.
• GET /users/{id}: Retrieve a specific user by ID.
• POST /users: Create a new user.
• DELETE /users/{id}: Delete a user by ID.

Location Endpoints

• GET /locations: Retrieve a list of all locations.
• POST /locations: Create a new location.
• DELETE /locations/{id}: Delete a location by ID.

Device Endpoints

• GET /devices: Retrieve a list of all devices.
• GET /devices/{id}: Retrieve a specific device by ID.
• POST /devices: Create a new device.
• PUT /devices/{id}: Update an existing device.
• DELETE /devices/{id}: Delete a device by ID.