User data management system for Hydroponics Network.
Users submit crop related data for their hydroponic crops such as temperature, electric conductivity, ph, and raw images of their crops via Whatsapp and receive AI based feedback for improving their crop's health.
Data representation is also available via user and admin dashboards.
** Environment variables must be set prior to deployment **
To install this project run
git clone https://github.com/Omriruvio/hydroponics-backend.git cd hydroponics-backend
npm install- Requires frontend deployment - see here: https://github.com/Omriruvio/hydroponics-frontend
- Requires mongoDB to be installed on the deployment OS
- Requires environment variables to be set up
- Requires Twilio, Twilio Studio flow, and linking the various keys to the environemnt variables
npm install
npm run dev npm install
node server.jsThe server will be avilable http://localhost:3000 (by default)
Client: NextJS, React, Styled Components
Server: Node, Express, MongoDB, Twilio
To run this project, you will need to add the following environment variables to your .env.local file
NODE_ENV - 'DEV' / 'production'
PORT - Desired port for server
TWILIO_SID - Twilio SID
TWILIO_AUTH_TOKEN - Twilio auth token
MONGODB_URI - MongoDB URI
HYDROPONICS_WA_NUMBER - Approved whatsapp business number
CLOUDINARY_CLOUD_NAME - From Cloudinary
CLOUDINARY_API_KEY - From Cloudinary
CLOUDINARY_API_SECRET - From Cloudinary
JWT_SECRET - Secret key for JWT encryption
Additionally for Whatsapp message flow to work - Twilio must be set up with a studio flow with the following varialbes:
BASE_URL - Pointing to the correct server IP/URL
To run unit and end to end tests, run the following command:
npm run testTo test twilio flow, log in to the twilio studio page:
- Add your phone number to is_testing_number value checks
- Change the BASE_URL parameter to point to your local environment (set up with ngrok for example)