Plantinha 🪴

A simple app to help you take care of your plants 🌱

ℹ️ This repository was made using create-t3-app, which is a full-stack framework with typesafe for writing applications in Next.js. You can check it out here.

Overview 📝

Plantinha is a web application designed to make plant care a breeze. With a user-friendly interface, Plantinha helps you keep your plants healthy and happy by managing watering schedules.

Features ✨

• Intuitive UI: Plantinha offers a clean and easy-to-use interface, making it simple for users to navigate and manage their plant watering schedules.
• Plant Management: Add, edit, and remove plants from your collection. Each plant can have its own unique watering schedule.
• Watering Reminders: Receive timely reminders for watering your plants. Customize the frequency of reminders based on the specific needs of each plant.
• User Authentication: Securely manage your plant collection by signing in with your account. This ensures that your plant data is personalized and accessible only to you. This is powered by Clerk.

Technologies used 🛠️

• Next.js - React framework
• TypeScript - Typed JavaScript
• Tailwind CSS - CSS framework
• TRPC - End-to-end type-safe APIs
• Prisma - ORM
• Clerk - Authentication
• Docker - Containerization
• PostgreSQL - Database

plantinha-files 📁

I have made a custom back-end for handling files (photos) in this application. Utilizing Express and Cloudflare R2 object store. You can check it out the repository here. You'll also have to run this in order to have the full functionality of Plantinha.

Developing locally 🚀

Docker

Docker is used to containerize the application with docker compose. Make sure to have it installed and running on your machine.

Clerk

This repository uses Clerk as a service for authentication. You'll need to create an account and set up a new Clerk application to get your API keys. You can use the .env.example file as a template for your .env file.

Getting started

After cloning and running plantinha-files, you can run Plantinha application locally by following these steps:

# clone the repository
$ git clone git@github.com:YuriBrunetto/plantinha.git
$ cd plantinha/
# install dependencies
$ pnpm install
# start the development server
$ pnpm dev
# this will also run `docker compose up -d`
# creating containers for both `plantinha` and `plantinha-files`

License 📄

Plantinha is licensed under the MIT License.