/gardenManager

App for managing and interrupting garden data.

Primary LanguageTypeScript

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Garden Manager

Front end repo for the Garden Manager PWA. Which is PWA for tracking garden data then eventually using the data for ai training models to help nutrient and plant growth management.
Explore the docs »

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

Built With

  • React
  • Bootstrap
  • CreateReactApp

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  1. Node
  2. NPM
  3. Backend API Repo

Installation

  1. Clone the repo
git clone git@github.com:CCecilia/gardenManager.git
  1. Change Dir
cd gardenManager/
  1. Install Dependencies
npm install
  1. Create .env file
touch .env
  1. Add the following values for local dev change as needed.
GARDEN_MANAGER_API='http://localhost:5000'
HOST='localhost'
BASE_URI='http://localhost:5000'
  1. Start dev server
npm start

(back to top)

Roadmap

  • Feature 1

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @christian3489 - christian.cecilia1@gmail.com

Project Link: GardenManager

(back to top)

Acknowledgments

(back to top)