Skip to content

lzheng0212/JD_SLS1105

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Institute of Education and Regenerative Communities

JIB - Team 1105

Tianhao Dai, Jiawei Li, Ricky Lin, Lai Wang, Jiaxi Xu, Lidan Zheng

πŸ“– Table of Contents

Table of Contents
  1. ➀ About The Project
  2. ➀ Overview
  3. ➀ Install Guide
  4. ➀ Release 1.0
    1. ➀ Features (Release 1.0)
      1. ➀ Feature 1: Post
      2. ➀ Feature 2: Event
      3. ➀ Feature 3: Timeline
      4. ➀ Feature 4: Map
      5. ➀ Feature 5: Donation
      6. ➀ Feature 6: FAQ
      7. ➀ Feature 7: Admin Portal
    2. ➀ Bug fixes (Release 1.0)
    3. ➀ Bugs (Release 1.0)
  5. ➀ Technical Wiki

-----------------------------------------------------

🧐 Project philosophy

We see the importance of being able to concentrate valuable information into a single area. By building a platform that allows the sharing of keystone information in upholding land fertility for future generations provided by The Institute of Education and Regenerative Communities to farmers; we can create a focal point of valuable information from our client to the farmers.

Alternatives to our solution could be a potential option, however, creating this project with the sole intention of providing educational programs to farmers, we are able to meet every need of our client that they desire. Using an open-source project could meet some aspects that our client needs but aren’t able to fully captivate their ideas. This is where we come in and build a website to fully materialize their ideas. By working with the client directly and understanding their vision, it allows us to satisfy their goals and adjust to any requirement they may have. -----------------------------------------------------

πŸ“’ Overview

The Problem

To introduce, educate small farmers, people who are interested in agriculture in regenerative landuse and connect farmers and organization in a convenient and efficient way.

The Solution

An interactive website platform that supports and provides educational information about regenerative land-use program for intergenerational users.

Target Users

Student participants, schools, farmers, landowners, land seekers, and funders.

Our Product

Our product is an informative and interactive website that provides a way for farmers and people with interest about agricultural regenerative landuse. It is a non-profit, focusing on intergeneration interactive education for proper landuse. -----------------------------------------------------

πŸ“’ Install Guide

  1. Pre-Requisities
  2. Download
    1. Create or locate a directory for the repository
    2. Right click inside the directory and click "Git Bash Here" and a terminal will open
    3. Clone the repository by typing the following "git clone https://github.com/lzheng0212/JD_SLS1105.git"
    4. Now you should have a local copy of the project on your machine
  3. Installing project dependencies
    1. Now on your local machine where you have a copy of the project navigate into JD_SLS1105 -> interactive-web directory
    2. Right click and click "Git Bash Here"
    3. Type "code ." into the terminal and Visual Studio Code should have opened with the project files
    4. Open the terminal in Visual Studio Code and type "npm install" to install all dependencies for the project
    5. Once the dependencies have installed you should be able to run the website on your local machine
  4. Running Application
    1. Type "npm start" in the Visual Studio code terminal and the website should open with your browser

πŸ“² Features (Release 1.0)

All sections can be expanded to read more!

🌟 Post

The Post tab enables our client to post any informational & educational materials, blogs or news to the website. The users can click on any post to view the full text. (click to read more)

🌟 Event

The Event page consists of a calendar that will display the events in the selected month. Users can use the buttons to navigate through months or use the month picker on the right to pick a month. (click to read more)

Click on event

When clicking on a specific event, the event details will be shown.

🌟 Timeline

The timeline will display the important events in descending time order. The important events can be of the organizations, or milestone in local agriculture, and etc... (click to read more)

Design

The timeline events are displayed in a carousel style. By designing it not in a traditional timeline style, the users can view through all the timeline events in the order of time to learn more about the development of the organization.

🌟 Map

The map page displays the organization's influence or footprint at the location pined. By hovering over the pin, you will see some details about the location. (click to read more)

🌟 Donation

The website is for a non-profit organization, donations will greatly help the organization with expense and planning of events. (click to read more)

Payment

We are using Stripe to facilitate payments, and to ensure security.

🌟 FAQ

The FAQ section provides the users with common questions from people and answers from the organization. Users can also contact the organization through the form on the website to ask questions. (click to read more)

Contact Us

The page contains the form to send to the organization.

🌟 Admin Portal

The admin portal is only for admin of the website. Through the portal, they can create/edit/delete posts, calendar events, timeline and map; as well as browsing quetsions from users, and post FAQ to the website. (click to read more)

🌟 Bug Fixes (Release 1.0)

  • Post with images inside the content area is resizable now.

🌟 Bugs (Release 1.0)

  • After creating a post or events the categories field remain while other fields are cleared.
  • If there are no post the footer moves too far up revealing blank space.

-----------------------------------------------------

πŸ‘¨β€πŸ’» Technical Wiki

Hey, glad to see you here! You must be interested in our technical stack.

Here's a brief high-level overview of the tech stack the website uses:

  • This project uses the React for constructing user interface. React is a user interface library coded with JavaScript. It is a tool to build components of the website for displaying.
  • For persistent storage (database), the website uses the Firebase which allows for user authentication and data transaction.

For more information on the technologies that power this website, check out the Wiki from this project. -----------------------------------------------------




πŸ’› Thank you!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages