DanielRhein / soilandgreen

Grap your shovel and pitchfork to start your gardening project. Keep the plants healthy and plan your regular irrigation of crops. Get tipps to start with small novice projects and become a gardening maniac.
GNU General Public License v3.0
1 stars 3 forks source link

no_entry: [DEPRECATED] Active at https://github.com/soilandgreen

deprecated

This repository where created on Hackathon last year and its results has been moved to an organisation

obsolete

soilandgreen

Grap your shovel and pitchfork to start your gardening project. Keep the plants healthy and plan your regular irrigation of crops. Get tipps to start with small novice projects and become a gardening maniac.

description

features planned

MVP Minimal set of vialable product (Hackathon_2019)

Nice to have

changelog

This section contains recent changelog informations

prepare hackathon 2019

2019/10/18 - Daniel Rhein

- Adding some more information to the Readme.
- Create the branch.  
- Create an Component UML diagramm as overview
- Describe features planned.
- Create some pitch pics.
- Components-devlopment-suggestion
- er-diagramm-example added

getting started with the project

2019/10/20 - Kevin Krieger; Sophie Schlegel; Daniel Rhein

 - Create Api-Backend with Php Symphonie (Kevin Krieger)
 - Create QT-QML-Demo-Application (Sophie Schlegel)
 - Create some documentation stuff (UMLs) (Daniel Rhein)

make it run

2019/10/21 - Andreas Sander, Kevin Krieger

- Andreas Sander backed an react frontend for SoilAndGreen
- Kevin Krieger finalized  Api-Backend for MVP 

installation & execution

### Backend:
- Requirements
  - PHP 7.2
  - Composer
To run the backend you need to open sog-frontend and run composer install

### Frontend:
-Requirements
   - Qt 12.5
   or React:
   - node.js

To run the react-frontend you need to execute npm run start.
To run the qt-frontend you need to execute qt-creator; open the project and execute it

how to help

contribution guideline

Create a branch that descripe your feature in the change-log section
Keep the code clean and simple (KISS). Document your code.
Add your name to the contributors list. Build your feature within 
the branch. If you think your are finished, let some of the other contributors know
about your changes. If the review has been done, you can push it to develop.
Development-branch is the main branch. From here an release will be created into the master branch. 

contributors