Water my plants - Backend

This is the backend for "Water my plant frontend"

View project Report Bug Request Feature

Table of Contents

1. Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Features
4. Contributing
5. Contact
6. Acknowledgments

Built With

• Express.js
• Browserless Docker Image
• Videoshow

(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

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/ivaylonikolov7/water-me-backend.git

2. Install NPM packages

   npm install

3. You should copy the env variables from .env.example and create a new .env variables with your own. The app doesnt use smtp and jwt variables so you can just ignore them.

4. yarn dev

   for development purposes.

   yarn start

   i production.

(back to top)

Features

• Makes a picture of the stream every 4 hours
• Makes a progress video every day
• Has a REST API
• Leadeerboard for which countries watered the plant the most

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

Ivaylo Nikolov - https://ivaylo.codes - [email protected]

(back to top)

Acknowledgments

• https://www.flaticon.com/

(back to top)