README.md

As our final project for Makers Academy, we created Triffid. It's a mobile app that helps users monitor their house plants and it's built using React Native so it's compatible with both iOS and Android operating systems.

Read our User Stories here.

 

🌱 Illustrative Screenshots:

 

 

🌱 App Features:

 

• Registration and Sign In
• Create and edit house plant profiles:
  • Nickname and type of plant
  • Watering frequency
  • Last time watered
  • Notes section
• Notifications when plants need watering
• Plant Discovery - using Trefle API

 

🌱 Technologies Used:

 

Built with the MERN stack:

• Mongo DB Atlas
• Express (Node.js)
• React Native (Expo)

Tools:

• Jest for unit testing
• Trello for workflow
• Balsamiq and Figma for wireframing and mockups
• Insomnia as an API testing tool
• Xcode for user interface testing

 

🌱 Installation & Usage:

 

After cloning the project, execute the following commands:

 

In the project root directory:

npm install -g expo-cli 
npm install -g nodemon 
npm install 

Backend:

To run the server:

cd backend
npm install 
nodemon app 

Frontend

Return to the project root directory and execute the command below to launch the app:

expo start  

Tests

Unit Tests

cd backend
npm test

🌱 Team:

• Annabel Bligh
• Margarida Martelo
• Samantha Gottlieb
• Symion Edwards

 

🌱 More Info:

 

While developing this project, we aimed to follow Agile practices. Our record of the process can be found here.