2023-12-01 14:25:15 -05:00
<!-- Header -->
< div id = "top" align = "center" >
< br / >
<!-- Logo -->
< img src = "https://git.zakscode.com/repo-avatars/02c3c82a2c192095fa04a6ea4d92d9614d37ab508fc948938b37a9cfd3196734" alt = "Logo" width = "200" height = "200" >
<!-- Title -->
2023-12-06 15:14:00 -05:00
### GrowBot
2023-12-01 14:25:15 -05:00
<!-- Description -->
2023-12-06 15:14:00 -05:00
Plant Manager
2023-12-01 14:25:15 -05:00
<!-- Repo badges -->
2023-12-06 15:14:00 -05:00
[![Version ](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/grow-bot/tags&query=$[0].name )](https://git.zakscode.com/ztimson/grow-bot/tags)
[![Pull Requests ](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/grow-bot&query=open_pr_counter )](https://git.zakscode.com/ztimson/grow-bot/pulls)
[![Issues ](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/grow-bot&query=open_issues_count )](https://git.zakscode.com/ztimson/grow-bot/issues)
2023-12-01 14:25:15 -05:00
2023-12-06 15:14:00 -05:00
<!-- Links -->
---
< div >
< a href = "https://git.zakscode.com/ztimson/grow-bot/releases" target = "_blank" > Release Notes< / a >
• < a href = "https://git.zakscode.com/ztimson/grow-bot/issues/new?template=.github%2fissue_template%2fbug.md" target = "_blank" > Report a Bug< / a >
• < a href = "https://git.zakscode.com/ztimson/grow-bot/issues/new?template=.github%2fissue_template%2fenhancement.md" target = "_blank" > Request a Feature< / a >
< / div >
---
2023-12-01 14:25:15 -05:00
< / div >
## Table of Contents
- [GrowBot ](#top )
- [About ](#about )
- [Built With ](#built-with )
- [Setup ](#setup )
- [Development ](#development )
- [License ](#license )
## About
GrowBot is a service intented to monitor & aid in the growing plants. It is meant to run on a [Raspberry Pi ](https://www.raspberrypi.com/ ) with a camera & electronics to automatewater pumps & lights.
By creating grow profiles the amount of water & light can plants recieve can also be adjusted to ensure consistant results. Aditionally you can take notes at anytime which will automatically include images & a record of tempatures, air & soil humidity.
### Built With
[![Angular ](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular )](https://angular.io/)
[![Bootstrap ](https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white )](https://getbootstrap.com)
[![Node ](https://img.shields.io/badge/Node.js-000000?style=for-the-badge&logo=nodedotjs )](https://nodejs.org/)
[![TypeScript ](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white )](https://typescriptlang.org/)
## Setup
< details >
< summary >
< h3 id = "development" style = "display: inline" >
Development
< / h3 >
< / summary >
#### Prerequisites
- [CMake ](https://cmake.org/download/ )
- [Node.js ](https://nodejs.org/en/download )
#### Instructions
1. Install the build tools: `npm install -g node-gyp windows-build-tools`
2. Install dependencies:
1. Client: `cd client && npm install`
2. Server: `cd ../server && npm install`
3. Start the Node server: `npm run start`
4. Start the Angular client: `cd client && npm run start`
5. Open http://localhost:4200
< / details >
## License
Copyright © 2023 Zakary Timson | All Rights Reserved
See the [license ](./LICENSE ) for more information.