davidgoldcode / ButchersBroom

Butcher's Broom

A web app to remind myself to water my plants
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

I love my plants, but I always forget them. I built this app so I could track, monitor and remind myself to water them

Built With

• React
• React-Redux
• Express
• NodeJS
• EmailJS

Getting Started

Contributions are encouraged!

Installation

1. Clone the repo

   git clone https://github.com/your_username_/butchersbroom.git

2. Install NPM packages

   npm install

The Endpoints

Auth
Method	Endpoint	Description	Calls For
POST	/api/auth/login	LOGIN	Username Password
POST	/api/auth/register	REGISTER	Username Password Email

Users
Method	Endpoint	Description	Calls For
GET	/api/users	Get all users	n/a
GET	/api/users/:id	Get user by ID	id
PUT	/api/users/:id	Edit user by ID	id
DELETE	/api/users/:id	Delete user	id

Plant Routes
Method	Endpoint	Description	Calls For
GET	/api/plants	get all of your plants	n/a
GET	/api/plants/:id	get specific plant	id
PUT	/api/plants/:id	edit plant	id
DELETE	/api/plants/:id	delete plant	id

The Technology

React
NodeJS
Redux
Express
Knex

Contributing

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

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

Contact

David Gold - @davidigold

License

MIT