Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/helloimalemur/aquariquality

Intended on being some sort of Aquarium water quality and progress tracking web application
https://github.com/helloimalemur/aquariquality

aquarium aquarium-tank tracking water-quality

Last synced: 5 days ago
JSON representation

Intended on being some sort of Aquarium water quality and progress tracking web application

Host: GitHub
URL: https://github.com/helloimalemur/aquariquality
Owner: helloimalemur
Created: 2024-02-05T04:45:28.000Z (9 months ago)
Default Branch: master
Last Pushed: 2024-05-12T22:53:38.000Z (6 months ago)
Last Synced: 2024-05-12T23:34:10.569Z (6 months ago)
Topics: aquarium, aquarium-tank, tracking, water-quality
Language: Rust
Homepage:
Size: 177 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # AquariQuality

## Work in Progress

## Intended on being some sort of Aquarium water quality and progress tracking web application

## Development and Collaboration

#### Feel free to open a pull request, please run the following prior to your submission please!

    echo "Run clippy"; cargo clippy -- -D clippy::all

    echo "Format source code"; cargo fmt -- --check

# deps

```shell

pacman -S xdo xdotool base-devel

```

## Start your own Docker development mariadb instance

```shell

## Bring your own SQL server;

export DOCKER_MARIADB_DBHOST="127.0.0.1";

export DOCKER_MARIADB_DBPORT="3306";

export DOCKER_MARIADB_DBNAME="mdb";

export DOCKER_MARIADB_DBHOSTPW="Password123!";

export DOCKER_MARIADB_DATABASE="mydatabase";

export DOCKER_MARIADB_USER="'devuser'";

export DOCKER_MARIADB_TABLE="mytable";

docker run -p "$DOCKER_MARIADB_DBHOST":"$DOCKER_MARIADB_DBPORT":"$DOCKER_MARIADB_DBPORT"  --name "$DOCKER_MARIADB_DBNAME" -e MARIADB_ROOT_PASSWORD="$DOCKER_MARIADB_DBHOSTPW" -d mariadb:latest &

sleep 30s;

mariadb -h "$DOCKER_MARIADB_DBHOST" -u root -p"$DOCKER_MARIADB_DBHOSTPW" -e "CREATE DATABASE $DOCKER_MARIADB_DATABASE;";

mariadb -D "$DOCKER_MARIADB_DATABASE" -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e 'CREATE TABLE `"$DOCKER_MARIADB_TABLE"` (`id` int(11) NOT NULL AUTO_INCREMENT,`method` varchar(255) NOT NULL,`host` varchar(255) NOT NULL,`port` varchar(255) NOT NULL,`uri` varchar(255) NOT NULL,`headers` varchar(255) NOT NULL,`body` varchar(6255) NOT NULL,PRIMARY KEY (`id`));';

mariadb -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e "CREATE USER $DOCKER_MARIADB_USER@'%' IDENTIFIED BY 'password';";

mariadb -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e "GRANT ALL PRIVILEGES ON *.* TO $DOCKER_MARIADB_USER@'%';";

mariadb -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e "FLUSH PRIVILEGES;";

echo "connect with: mariadb -h $DOCKER_MARIADB_DBHOST -uroot -p$DOCKER_MARIADB_DBHOSTPW";

mariadb -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e 'CREATE DATABASE aquariquality;';

mariadb -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e 'USE aquariquality;';

mariadb -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e 'CREATE TABLE `user` (`userid` INT NOT NULL,`name` VARCHAR(255) NOT NULL,`email` VARCHAR(255) NOT NULL,`password` VARCHAR(255) NOT NULL,PRIMARY KEY (`userid`)) ENGINE=InnoDB;' aquariquality;

mariadb -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e 'CREATE TABLE `tank` (`userid` INT NOT NULL,`tankid` INT NOT NULL,`name` VARCHAR(255) NOT NULL,`size_gallons` INT NOT NULL,`height` INT,`length` INT,`width` INT,`volume` INT,`weight` FLOAT,PRIMARY KEY (`userid`)) ENGINE=InnoDB;' aquariquality;

mariadb -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e 'CREATE TABLE `parameter` (`userid` INT NOT NULL,`ph` FLOAT,`kh` FLOAT,`ammonia` FLOAT,`nitrite` FLOAT,`nitrate` FLOAT,PRIMARY KEY (`userid`)) ENGINE=InnoDB;' aquariquality;

mariadb -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e 'CREATE TABLE `fish` (`userid` INT NOT NULL,`tankid` INT NOT NULL,`fishid` INT NOT NULL,`name` VARCHAR(255) NOT NULL,`species` VARCHAR(255) NOT NULL,`qty` INT,PRIMARY KEY (`fishid`)) ENGINE=InnoDB;' aquariquality;

mariadb -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e 'CREATE TABLE `session` (`userid` INT NOT NULL,`name` VARCHAR(255) NOT NULL,`email` VARCHAR(255) NOT NULL,`sessionid` VARCHAR(255) NOT NULL,PRIMARY KEY (`sessionid`)) ENGINE=InnoDB;' aquariquality;

mariadb -h "$DOCKER_MARIADB_DBHOST" -uroot -p"$DOCKER_MARIADB_DBHOSTPW" -e 'SHOW TABLES;' aquariquality;

```

## Backend API endpoints

    curl -XPOST -H'X-API-KEY: 12790066417744034365' localhost:8723/api/create/

    curl -XPOST -H'X-API-KEY: 12790066417744034365' localhost:8723/api/delete/ -d'{"api_key":"9860738100897034443"}'

    curl -XPOST -H'X-API-KEY: omganotherone' localhost:8723/api/create/parameter/ -d '{ "session_id": "String", "user_id": 4412, "ph": 0.0, "kh": 0.0, "ammmonia": 0.0, "nitrite": 0.0, "nitrate": 0.0}'

    curl -XPOST -H'X-API-KEY: omganotherone' localhost:8723/login/ -d '{"email":"[email protected]","password":"password"}'

    curl -XPOST -H'X-API-KEY: omganotherone' localhost:8723/logout/ -d '{"session_id":"password"}'

    curl -XPOST -H'X-API-KEY: omganotherone' localhost:8723/verify/ -d '"session_id":"sessionid"}'

    curl -XPOST -H'X-API-KEY: omganotherone' localhost:8723/user/create/ -d '{"name":"johnny","email":"[email protected]","password":"password"}'

    curl -XPOST -H'X-API-KEY: 12790066417744034365' localhost:8723/api/delete/user/ -d '{"name":"johnny","email":"[email protected]"}'

## Project scheme

```sql

CREATE DATABASE aquariquality;

USE aquariquality;

```

```sql

CREATE TABLE `user` (

`userid` INT NOT NULL,

`name` VARCHAR(255) NOT NULL,

`email` VARCHAR(255) NOT NULL,

`password` VARCHAR(255) NOT NULL,

PRIMARY KEY (`userid`)

) ENGINE=InnoDB;

```

```sql

CREATE TABLE `tank` (

`userid` INT NOT NULL,

`tankid` INT NOT NULL,

`name` VARCHAR(255) NOT NULL,

`size_gallons` INT NOT NULL,

`height` INT,

`length` INT,

`width` INT,

`volume` INT,

`weight` FLOAT,

PRIMARY KEY (`userid`)

) ENGINE=InnoDB;

```

```sql

CREATE TABLE `parameter` (

 `userid` INT NOT NULL,

 `ph` FLOAT,

 `kh` FLOAT,

 `ammonia` FLOAT,

 `nitrite` FLOAT,

 `nitrate` FLOAT,

 PRIMARY KEY (`userid`)

) ENGINE=InnoDB;

```

```sql

CREATE TABLE `fish` (

`userid` INT NOT NULL,

`tankid` INT NOT NULL,

`fishid` INT NOT NULL,

`name` VARCHAR(255) NOT NULL,

`species` VARCHAR(255) NOT NULL,

`qty` INT,

PRIMARY KEY (`fishid`)

) ENGINE=InnoDB;

```

```sql

CREATE TABLE `session` (

`userid` INT NOT NULL,

`name` VARCHAR(255) NOT NULL,

`email` VARCHAR(255) NOT NULL,

`sessionid` VARCHAR(255) NOT NULL,

PRIMARY KEY (`sessionid`)

) ENGINE=InnoDB;

```