Skip to content

Gosamat/found-foliage-project-server

Repository files navigation

🌱 Found Foliage

About The Project

With our user-friendly website, identifying plants has never been easier. Just upload a photo of a plant, and our "smart" AI will quickly tell you its name and characteristics.

Create an account to unlock the Garden Companion feature. Each plant you identify gets saved in your personal garden album. You can even add notes, like watering schedules or care tips, to keep your plants healthy and thriving.

Explore the world of plants with "PlantSnap Garden Companion" – your go-to tool for all things green!

In short:

  • Upload a plant and it'll tell you the name and some basic info. 🌼
  • You can create an account to make your own garden 🌼
  • You can add notes to each plant. 🌼

(back to top)

Table of Contents
  1. About The Project
  2. Contact
  3. Acknowledgments

Built With

User Stories

404 Page Display - If I navigate to a non-existent page, I desire the presence of a well-crafted 404 page. This will help me understand that the issue lies with my actions.

500 Error Page - When technical glitches occur due to the super team's work, I wish to encounter an aesthetically pleasing error page. This will help me recognize that the responsibility does not rest with my actions.

Homepage Access - My objective is to easily reach the homepage to log in and sign up.

About Page Access - I seek the capability to effortlessly access the About page to review information about the developer team.

Sign Up Functionality - I have a desire to register on the website, facilitating the upload of photos of plants I intend to identify.

Login Process - I aim to execute a seamless login process on the website to regain access to my account.

Logout Feature - I aspire to be able to log out from the website, ensuring the security of my account from unauthorized access.

Plant Addition - I am inclined to upload a photo of a plant for identification purposes.

Plant Details Viewing - I wish to have the capacity to view comprehensive information about identified plants.

Profile Page / Your Garden - I hold an interest in viewing my profile, encompassing all uploaded plants. Moreover, I want to name my garden, describe it, modify the garden's background, and alter my profile image.
- ** Optional ** Search Functionality - I wish to possess the ability to conduct searches for specific plants.

Garden Categorization - I seek the functionality to categorize my garden into sections such as "front yard," enabling the assignment of particular plants to these defined categories.


Server Routes (Back-end):

Method Route Description Request - Body
GET / Main page route. Renders home index view.
GET /login Renders login form view.
POST /login Sends Login form data to the server. { email, password }
GET /signup Renders signup form view.
POST /signup Sends Sign Up info to the server and creates a user in the DB. { email, password, username }
GET /private/edit/garden Private route. Renders edit-garden form view.
PUT /private/edit/garden Private route. Sends garden info to the server and updates the user in DB. { garden title, userProfilePic }
GET /plants Renders plant-list view.
GET /plants/details/:id Renders plant-details view for the particular restaurant.
GET /plant/add Renders addPlant view.
GET /plants/details/:id Renders plant-details view for the particular restaurant.
GET /about Renders about view.

Models

  • User model
  • Garden model
  • Plants model

API's

PLANTS API PlantNet API


Packages


Other Info:

Backlog

See the Trello board.


Links

Git

The url to your repository and to your deployed project

Repository Link

Deploy Link


Slides

The url to your presentation slides

Slides Link

Contributors

FirstName LastName - <github-username> - <linkedin-profile-link>

FirstName LastName - <github-username> - <linkedin-profile-link>

React + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •