Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wannacry081/makersync-django
The MakerSync API connects our Flutter mobile app with the machinery for converting PETG plastic into 3D printing filament. It has two versions: v1 links with Firebase Firestore via firebase_admin in Python, while v2 uses SQLite.
https://github.com/wannacry081/makersync-django
django django-ninja django-ninja-extra firebase rest-api sqlite
Last synced: 8 days ago
JSON representation
The MakerSync API connects our Flutter mobile app with the machinery for converting PETG plastic into 3D printing filament. It has two versions: v1 links with Firebase Firestore via firebase_admin in Python, while v2 uses SQLite.
- Host: GitHub
- URL: https://github.com/wannacry081/makersync-django
- Owner: WannaCry081
- Created: 2024-04-03T11:57:54.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-20T02:14:49.000Z (6 months ago)
- Last Synced: 2024-05-20T03:26:31.047Z (6 months ago)
- Topics: django, django-ninja, django-ninja-extra, firebase, rest-api, sqlite
- Language: Python
- Homepage:
- Size: 266 KB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MakerSync [Django]
MakerSync API facilitates the interaction between our Flutter mobile app and the circuitry involved in the process of converting PETG plastic into 3D printing filament. It offers two versions: v1, which integrates with Firebase Firestore using firebase_admin in Python, and v2, which utilizes PosgreSQL.
> [!NOTE]
>
> When running this project locally, it utilizes SQLite as the default database engine.
## Tools Used
- [Django](https://www.djangoproject.com/)
- [Django Ninja](https://django-ninja.dev/)
- [Django Ninja-Extra](https://eadwincode.github.io/django-ninja-extra/)
- [Firebase Admin](https://github.com/firebase/firebase-admin-python)
- [Vercel (Deployment)](https://vercel.com/)
## Endpoints
You can access the MakerSync API endpoints through the provided documentation. Simply browse to [MakerSync v1 API Documentation](http://127.0.0.1:8000/api/v1/docs) or [MakerSync v2 API Documentation](http://127.0.0.1:8000/api/v2/docs) in your local hosts to get an overview of available endpoints and interact with the API.
### v1 Endpoints
MakerSync v1 utilizes Firebase as its primary database system, offering real-time updates and changes through the Firebase console website.
#### Users
- **GET** `/api/v1/machines/{machine_code}/users/`: Retrieve all users within the machine identified by a unique sensor ID.
- **POST** `/api/v1/machines/{machine_code}/users/`: Add a user to a specific machine identified by its sensor ID.
- **GET** `/api/v1/machines/{machine_code}/users/{email}`: Retrieve user information based on email within a specific machine.
- **PUT** `/api/v1/machines/{machine_code}/users/{email}`: Update user information within a specific machine based on email.
- **DELETE** `/api/v1/machines/{machine_code}/users/{email}`: Delete a specific user from the machine based on email.
#### Machine
- **GET** `/api/v1/machines/{machine_code}/sensors`: Retrieve sensor information for a specific machine based on its sensor ID.
- **POST** `/api/v1/machines`: Add a new machine to the database identified by its sensor ID.
- **PUT** `/api/v1/machines/{machine_code}/sensors`: Update all information related to a specific machine based on its sensor ID.
- **DELETE** `/api/v1/machines/{machine_code}/sensors`: Delete a machine from the database based on its sensor ID.
### v2 Endpoints
MakerSync v2 utilizes PostgreSQL as its primary database system, offering unlimited user request and response capabilities.
#### Machine
- **POST** `/api/v2/machines`: Create a new machine entry in the database with a unique machine code.
#### Sensor
- **GET** `/api/v2/machines/{machine_code}/sensors`: Retrieve all sensors associated with a specific machine identified by its machine code.
- **POST** `/api/v2/machines/{machine_code}/sensors`: Add a new sensor to a specific machine identified by its machine code.
- **PUT** `/api/v2/machines/{machine_code}/sensors`: Update sensor information within a specific machine based on its machine code.
- **DELETE** `/api/v2/machines/{machine_code}/sensors`: Delete a specific sensor from the machine based on its machine code.
#### Notification
- **GET** `/api/v2/machines/{machine_code}/notifications`: Retrieve all notifications associated with a specific machine identified by its machine code.
- **GET** `/api/v2/machines/{machine_code}/notifications/{notification_id}`: Retrieve a specific notification by its ID within a machine identified by its machine code.
- **POST** `/api/v2/machines/{machine_code}/notifications`: Create a new notification associated with a specific machine identified by its machine code.
#### User
- **GET** `/api/v2/machines/{machine_code}/users`: Retrieve all users associated with a specific machine identified by its machine code.
- **GET** `/api/v2/machines/{machine_code}/users/{email}`: Retrieve user information based on email within a specific machine identified by its machine code.
- **POST** `/api/v2/machines/{machine_code}/users`: Add a new user to a specific machine identified by its machine code.
- **PUT** `/api/v2/machines/{machine_code}/users/{email}`: Update user information within a specific machine based on email and machine code.
- **DELETE** `/api/v2/machines/{machine_code}/users/{email}`: Delete a specific user from the machine based on email and machine code.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/WannaCry081/MakerSync-Django.git
```
2. Navigate to the project directory:
```bash
cd makersync-django
```
3. Install dependencies:
```bash
pip install -r requirements.txt
```
4. Migrate database:
```bash
python manage.py makemigrations v2
python manage.py migrate
# View changes using the admin page
python manage.py createsuperuser
```
5. Run the Django development server:
```bash
python manage.py runserver
```
6. Access the API documentation locally at [MakerSync v1 API Documentation](http://127.0.0.1:8000/api/v1/docs) or [MakerSync v2.0 API Documentation](http://127.0.0.1:8000/api/v2/docs).
### Additional Option
Alternatively, you can use the provided `run.sh` script to automate the setup process:
```bash
# In Windows
> run.sh [venv | pipenv]
# In Linux
$ chmod +x run.sh
$ ./run.sh
```
> [!NOTE]
>
> This script will automatically create a virtual environment, install the necessary dependencies, and run the Django API for you.
## Usage
Once the server is running, you can interact with the API using tools like cURL, Postman, or directly from your Flutter mobile app. Refer to the provided API documentation for detailed information on available endpoints and their usage.
## Contribution
Contributions to MakerSync-Django are welcome! If you have any ideas, suggestions, or improvements, feel free to open an issue or submit a pull request on the GitHub repository.