Skip to content

riheelh/growr-plant-exchange

 
 

Repository files navigation

GROWR-banner

Table of Contents

  1. Project Overview
  2. Deployement
  3. MVP
  4. Beyond the MVP
  5. Installation
  6. Usage
  7. Application Screenshots
  8. License
  9. Credit

Project overview

License: MIT

growr-about

Project Status:

MVP complete --> post MVP: ONGOING

In progress:

  • messenging/inboxing function: currently hardcoded
  • authentication: session/connect-mongo vs passport vs JWT

Issues to debug:

  • mobile-friendly
  • sticky navbar
  • "read more" feature for text inside cards

Project Members:


Deployment

This project is deployed through Github Pages @ Growr

Too excited to read about the boring parts >> go take a SNEAK PEAK


MVP

Project-build Aspects:

The following components are used to build the code for this project:

  • FRONTEND

    • React.js
    • React-router-dom
    • Material-UI
  • BACKEND

    • Express.js
    • MongoDB > Mongoose.js
    • MongoDB Atlas Cloud Database
  • Signifcant packages

    • axios > for data requests
    • bcrypt > for password hashing
    • cors > for browser security
    • multer s3 & AWS > for image file uploads to cloud
    • dotenv > for environment variables
  • Third-party API

Sneak Peak:

User Profile:

growr-profile

Trades page > navigate to other user profiles:

growr-trades

Events page:

growr-events

Places page:

growr-places

Add feature:

growr-add

Process:

Tasks

All members of the project are full-stack coders and put work into both sides of developement: these generalized tasks and assignments act as a jumping block to initiate work flow and designate responsibility. See Project Members section for reference.

  • FRONTEND: FW / MG

    • research on react CSS library > Material-UI
    • design UI navigational flow chart for pages/components
    • build skeleton of react-creat-app directory structure
    • design/edit/finalize style modifications for optimal UI/UX
    • implement API calls and react hookk
    • image upload and render function
    • messaging/inboxing function
    • deployement and post-deployement issues
  • BACKEND: BM / PH / RH

    • design models for mongoose/mongoDB schema and documents
    • design API workflow
    • mock up data to seed database in developement
    • research third party API for location functionality
    • image upload and render function
    • messaging/inboxing function
    • deployement and post-deployement issues

Beyond the MVP

  • landing page search by zipcode function to render demo page
    • for non-signedup users
    • readme only with any interaction to redirect to signup page
  • develope messaging/inbox function into forum based UI
  • addition UI features for cards
    • favorite trades and places
    • "I'm going!" function for events
    • countdown / autodelete for events
  • admin user features for basic site management
    • validate and maintain "static" PLACES ie. "Did that nursery move locations?"
    • follow up on duplicate postings or violation of terms(?)
  • Guestbook feature for users
  • allowing multiple image uploads for posts

Installation

  1. Clone this repository onto local workspace
  2. Open Terminal (MacOS) or Git Bash (Windows) and change location to where you want the cloned directory
  3. Type git clone and paste copied respository
  4. This application uses Mongoose.js - please make sure you have the following tools installed for local server database use:
  5. This application uses the dotenv package to set up environment variables - use the search function in your code editor to locate the following keys. It's up to you if you want to install/download/signup for any of these:
    • API_KEY > required for Google Maps Geocoding API
    • BUCKET > required for AWS
    • AWS_ID > required for AWS
    • AWS_SECRET > required for AWS
    • REGION > required for AWS Cloud Database

Usage

For local server use through CLI:

npm install
npm run

License

This application is licensed under MIT, please see the corresponding file in the repo directory.

Credit

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 95.1%
  • CSS 3.9%
  • HTML 1.0%