Overview

What is this project?

The goal of this project is to collaborate with your Collab Lab team to create a “smart” shopping list app that learns your buying habits and helps you remember what you’re likely to need to buy on your next trip to the store.

How does it work?

As a user, you will enter items (e.g., “Greek yogurt” or “Paper towels”) into your list. Each time you buy the item, you mark it as purchased in the list. Over time, the app comes to understand the intervals at which you buy different items. If an item is likely to be due to be bought soon, it rises to the top of the shopping list.

Check out an example

The app will work in many of the same ways as iNeedToBuy.xyz (on which our project is based) with the exception that we will not be implementing barcode scanning (that feature would add a lot of scope to the project and wasn’t all that useful).

:tv: Check out a video demo of the example app here:

More details for contributors

🎉 If you’re a Collab Lab participant, first of all: WELCOME! We’re so excited to work with you and collaborate on something amazing.

Make your first contribution!

The first thing you will want to do before your kick-off call is make your first contribution to this repo. This will help make sure you’re ready to go on day one.

Get this project set up locally by following the instructions below in this README.
Add your name to the CONTRIBUTORS.md file
- Be sure to do this from your local environment and not from GitHub in your browser. The purpose (aside from highlighting our amazing team) is to make sure you’re local environment is all set up and ready to go come day 1!
- Commit to the main branch and push it up to the remote repo. (Over the next 8 weeks, we will rely on feature branches as we collaborate on the project, but for this task committing to main will do just fine.)

What else should contributors know?

For additional details on how your cohort will operate, please check out the project brief.

Project setup

Download Node and NPM

npm is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer.
Follow the instructions here to install Node.js and npm.

Clone project locally

On GitHub, navigate to the repo for your cohort’s project (you’re probably there right now, click the "Code" tab at the top).
Click the green "Clone or download" button and copy the web URL.
From your terminal, cd into the directory where you want this project to live.
Once you’re in the directory, type git clone followed by the web URL you just copied to your clipboard from GitHub.
Then navigate into the project by typing cd followed by the project directory’s name.

Update dependencies

Once you have the project locally and you are in the project directory, you’ll want to update all the project’s dependencies. To do so, type the following into your terminal: npm update
Maybe take a sip of coffee or check in on Twitter, this could take a minute -- don’t worry.

Access the project in your browser

After you’ve cloned the project locally and updated the dependencies, run the project by typing the following into your terminal: npm start. You should be able to see the project at localhost:3000.

🎉 You did it! You’re ready to start contributing. Don’t forget to complete the first task by adding your name to CONTRIBUTORS.md from your local enviroment, committing those changes, and creating a pull request.

Boilerplate information

Everything in this section is automatically generated when you create a new app using create-react-app. These details can be really helpful in learning how to launch and manage your React app with npm.

↓↓↓ create-react-app boilerplate ↓↓↓

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

`npm start`

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

`npm test`

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

`npm run build`

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

`npm run eject`

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

the-collab-lab / tcl-28-smart-shopping-list

readme

Overview

What is this project?

How does it work?

Check out an example