Currently with the 3rd party api from trefle.io removing their rest api this project is dead in the water. I am currently working on making a new api that will follow a plant identification guide I used back in college while earning my B.S. degree. This project will stay on my github for inspiration and to check back to see how much I have grown as a developer.
Backyard Botanist is a <tool>
that allows <novice plant enthusiast>
to <keep track of the plants they find and write notes about them>
.
When the user saves their plant it is saved to a local database with their notes, they are able to edit and delete notes and plants all together.
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of
<coding_language/dependency/requirement_1>
- You have a
<Windows/Linux/Mac>
machine. State which OS is supported/which is not. - You have read
<guide/link/documentation_related_to_project>
.
To use <Backyard Botanist>
, follow these steps:
It is a web application so just go to the following web adress and begin using.
<usage_example>
To contribute to , follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <yourInitials-branchName>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to the original branch:
git push origin <project_name>
- Create the pull request.
Alternatively see the GitHub documentation on creating a pull request.
If you want to contact me you can reach me at daprieu@gmail.com.
This project uses the following license: <license_name>.