/FrontEnd

Primary LanguageJavaScriptMIT LicenseMIT

LambdiPet

Deployed website: http://lambdipet.netlify.com

Description

LambdiPet (Renamed from GigaPet) is a mobile first design, allowing users to have quick on the go access to the app!

Being a parent we know you are always looking for ways to motivate your kids to eat. With this app, you can input the servings of food you child eats, and the child can watch their Lambdi Pet grow and flourish, or wither and struggle based on what food they eat.

LambdiPet gives your child control over feeding their little buddy and they are able to see what happens when they make healthy eating choices.

Getting Started

To begin using the App, follow the link and Sign Up for a new account with a username and password.

Choose a pet from one of four pet types, and name your pet.

On the dashboard, you'll be able to feed your pet, view the calendar, or edit your pet's name, as well as delete the pet to choose a new one.

Feeding pet: select Feed Pet, then choose a date to log, next choose a food category and food item. You can also create a new food item, or deleted a selected food item from the drop down menu.

View calendar: select View Calendar. The graph shows your food log, tracking data in all food categories. To view counts, click on the corresponding color. To isolate specific categories click on the tag to toggle the category on and off. Future features will show more datasets and allow users to show data by types of food item.

View levels: select Levels from the hamburger menu on the top right. Each pet type has four levels, for a total of 16 different pets. Click Level Up to simulate the next level reached. Click Level Down to revert back the previous level.

Log out: select Logout from the hamburger menu on the top right. Session storage will be cleared. Thank you for using LambdiPet!

Prerequisites

All of the below dependencies can be installed using: yarn install or npm install

Start development by creating a react app using: yarn start or npm start

Dependencies

This project was created using yarn and designed for react client side. Other dependencies include:

    "@fortawesome/fontawesome-svg-core": "^1.2.25",
    "@fortawesome/free-brands-svg-icons": "^5.11.2",
    "@fortawesome/free-solid-svg-icons": "^5.11.2",
    "@fortawesome/react-fontawesome": "^0.1.7",
    "axios": "^0.19.0",
    "babel-loader": "^8.0.6",
    "chart.js": "^2.9.3",
    "formik": "^2.0.4",
    "react": "^16.12.0",
    "react-animations": "^1.0.0",
    "react-dom": "^16.12.0",
    "react-loader-spinner": "^3.1.5",
    "react-redux": "^7.1.3",
    "react-router-dom": "^5.1.2",
    "react-scripts": "3.2.0",
    "redux": "^4.0.4",
    "redux-thunk": "^2.3.0",
    "styled-components": "^4.4.1",

API

base URL: https://gigapet3.herokuapp.com/api

Authentication

... Backend documentaion incomplete, see: (https://github.com/Build-Week-GigaPet3/BackEnd)

Registration:

... Missing token on registration.

Support

This is a developmental application, contact Robert Gordon (see below) for more information.

Authors and acknowledgment

Front End Engineer: Robert Gordon (https://github.com/RobertDGordon)

Backend Engineer: Madeline McIntosh (https://github.com/msmaddymac)

Project Lead: Kelly Moreira (https://github.com/misskellymore)

Full Repo: https://https://github.com/Build-Week-GigaPet3

Project status

This project was completed for a Lambda School build week January 2020. There may be updates to the application periodically.

License

This project is licensed under the MIT License - see the LICENSE file for details.