Skip to content

Arunesh-Gour/Aquaponics_System

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README

Aquaponics_System

AI based aquaponics automation system.

Installing / Getting started

Supported on:
  • Ununtu 20.04.
  • Windows 10.
  • Current version does not support installation.
  • Setup dev environment and get started.

Developing

Built with

  • Python==3.x
  • Django==3.2
  • Python3-tkinter

Prerequisites

For other requirements, see requirements.txt.

Setting up dev

  1. Clone repository into local system.
  2. cd to ./Aquaponics_System.
  3. pip install -r requirements.txt.
  4. You're ready!

Running dev version

NOTE:Perform points 2 to 6 only if it is first time.
$:Terminal commands.
$$:Python shell commands.
  1. cd to src/Applications/AquaponicsDjango/.
  2. $ python3 manage.py shell.
  3. $$ from django.contrib.auth.models import User.
  4. $$ user = User.objects.create_user(<username>, password='<password>').
  5. $$ user.save().
  6. $$ exit().
  7. Remember above username and password.
  8. $ python3 manage.py makemigrations.
  9. $ python3 manage.py migrate.
  10. $ python3 manage.py runserver.
  11. Open another terminal and cd to src/AquaponicsSystem/.
  12. $ python3 main.py.
  13. System is up and running.
  14. Ctrl-C in both terminals to quit.

Building

No build instructions. Simply setup and run.

Deploying / Publishing

Publishing not supported yet.

Versioning

0.0

Configuration

  • Use editor config provided under config/.
  • Remember username and password setup during dev setup.

Tests

Not available.

Style guide

Follows PEP 8 guidelines.

API Reference

Core API is provided under discussion section with name Core.

Database

  • Sqlite3 for web app user data management (Django built-in).
  • JSON for sensor reading storage (custom).

Credits

Collaborators

  • @Arunesh-Gour
  • @gauravc6
  • @kartik-kumar71
  • @Prakhar-623
  • @recker624
  • @sanskar-singh-rajput
  • @Vikram-BM

Licensing

See LICENSE.