Skip to content

Russell0014/Soil-Website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Soil Logo

SOIL

SOIL is a student-made website built with React. It's a place for users to learn about organic foods, getting diet tips & recipes. It's easy to use, with features like signing up, managing profiles, using a shopping cart, and diet planning.

Main Features

  • Landing Page: A welcoming first impression for users, providing an overview of the application.
  • Diet Planner: Lets users create their own profile and gives them recipes depending on when chosen health goals.
  • Garden Helper: A feature that provides users with a guide on organic gardening in their backyard, helping them grow their own organic vegetables.
  • Specials: Showcases purchasable products with indicators for special offers.
  • Profile: A personalized space for users to manage their account details and customize their diet plan.
  • Login and Sign Up: Lets users create their own account or log into an existing one.
  • Backend API

Usage

  1. Clone the repo.

  2. Create server/.env file containing

  3. Navigate into /client & /server

  4. Install dependencies, npm i

  5. Start the server, npm start

.env File

Your .env file should look like this:

URI=MYSQL_URI

Tests

  • To test the backend of the website, first follow the Usage guide
  1. Once all set up navigate into /server/tests
  2. Run npm run test
  • How were the tests set up?

    • Using jest we implemented generic and some edge case requests and mocked what a generic and valid return would be
  • For more detail regarding the individual unit tests:

    • Refer to server/tests/cartTests.js about the shopping cart features
    • Refer to server/tests/reviewTests.js about the review features

Dependencies

Acknowledgements

Made by