Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 5.52 KB

README.md

File metadata and controls

75 lines (49 loc) · 5.52 KB

🍏🔢 Range Reveal 📉🍐

Capstone Project - Aimee Oz - Ada Developers Academy

Contents

  1. Installation Guide
  2. What is Range Reveal?
  3. How to use Range Reveal?
  1. Clone this repository. $ git clone https://github.com/marks214/reveal.git
  2. Navigate to the project directory. $ cd reveal
  3. Install the dependencies. $ npm install
  4. Run the server. $ npm start

Stuff You Should Know:

In package.json the proxy for the backend is set to http://localhost:5000/. This may need to be changed to reflect your local backend server's address (e.g., http://127.0.0.1:5000, http://localhost:3001, etc.).

Currently the backend url accessed by the app is https://www.rangereveal.aimeeoz.com. Set it to your local server.

Range Reveal is a food-tracking web app. It is intended to help users track what they eat per day. Users can set custom energy and macronutrient goals (range), search through a database of foods, and add custom foods to the database. Users can then access their food journals, modify if needed, and see (reveal) graphs of their energy and macronutrient consumption over the course of a week.

  1. Login or create an account. You will then be prompted to confirm your account.

  1. After login you will see your user profile with default energy and macronutrient ranges.

You can enter custom goals for yourself by either typing them directly in the fields, or modifying the existing values using the arrows. You will need to click on "update goals" at the bottom of the page to save changes.

  1. Start tracking foods by clicking on Food Search in the navigation bar.

On the Food Search page you can search for different foods by typing in the name of a food or brand (e.g., apple, honeycrisp apple, Kirkland, etc.), and then pressing enter. Click add on the food card that appears, if you are satisfied with the results of the search.

  1. You can create a custom food using the form on the right.

After you fill out the form, click on the "Add Food" button. Your custom food will be added to the database for future searches. Your custom entry will appear to the left where you can add it to your food journal.

  1. Once your have finished searching and adding your foods you can click on the "Data" tab at the top to navigate to your food journal. Here you can see and modify your food journal. Additionally, you can choose to reveal your weekly data.

Example of new user graphs: