Skip to content

fedellen/list-together

Folders and files

NameName
Last commit message
Last commit date

Latest commit

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

Repository files navigation

Fullstack TypeScript React Grocery List App

List Together

List Together is a simple, modern list app built with sharing capabilities. Completely free to use and open source.

https://www.listtogether.app

Netlify Status

πŸš€ Features

  • Create and Manage Lists
  • Add, Strike, and Delete Items
  • Add Notes to Items
  • Share Lists
  • Historical Auto Complete
  • Undo Capabilities
  • Simple oAuth Sign-up / Login
  • Responsive Mobile Design
  • Keyboard Accessibility

Users can easily create an account by signing in with Google, Twitter, or Facebook. The database's User entity will only store the user's email. This is to be used in sharing lists with other users. No passwords stored, no account information to remember.

Lists can be renamed, removed, or shared to other users. Every list contains a history of items added and removed to be used in that list's Auto Complete and Smart Sort features.

Users with access to a list can add items, strike items, and/or delete items.

Most list actions are stored locally to be used in the Undo feature. Users can conveniently undo or redo these actions to revert the list back to their preferred state.

Striking items will immediately sort that item to the bottom on the list. Un-striking will sort the item back into the list. While a list has striked items, users can enter Review mode to view only their striked items. While in Review mode, users can quickly delete all currently striked items on the list.

Users can easily share their lists with friends or family via email address. The shared user must have an account already created for server to accept it as a sharable email address. While online, the shared user will receive a notification and the list immediately upon sharing.

Owners of a list can choose to limit the privileges they want that shared user to have. Available Privilege levels include read, add, strike, and full. This feature is intended to protect your list from being cleared out accidentally by younger family members or friends but still allowing them access to add items or read the list.

Each user can sort the order the items for their own unique display, without disrupting the order of shared users' sorted items. Items on the list can be sorted manually, or by using the SmartSort feature. As the history of your lists grow, SmartSort will remember the order in which your items have previously been removed.

By default, the SmartSort option will try to sort your list into the route you take through the store. Alternatively you can save your own order for each item by sorting your list manually then using the SaveOrder option located in the HeaderOptions.

This app also features some limited offline functionality. Users can install the app locally as a PWA. When in offline mode, they can view their last available list queries from the cache. Interacting with the lists does not work offline.

πŸ’½ Backend made with:

The backend is currently deployed on a Digital Ocean droplet with Dokku.

To install and test List Together locally, you will first need to setup Postgres and Redis on your system. You will also need to provide a .env file with the appropriate fields filled in, see .env.example. The current dev environment requires at least one method of logging in via a Passport API (Google / Twitter / Facebook), in which you'll need to create a dummy app for testing. Afterwards, install and run the server in development mode with:

cd ./server && yarn && yarn dev

When making changes to the code in development mode you'll need to open another terminal to the /server directory and run:

yarn watch

Before committing any changes to the backend be sure to test the resolvers by running:

yarn test

I used Ben Awad's awesome lireddit repository as a starting point for the backend and bootstrapped with:

typeorm init --name list-together --database postgres

πŸ’» Frontend made with:

Also a huge thanks for all of the work put into the React+TypeScript Cheatsheets

The front-end is hosted on Netlify and available at: https://www.listtogether.app

Updates to the /web directory on the master branch will trigger Netlify deployment.

To install and run the front end locally you will need to run:

cd ./web && yarn && yarn start

Frontend was bootstrapped with:

npx create-react-app my-app --template cra-template-pwa-typescript

πŸ“– About the project

List Together is a project I've created to upgrade our personal grocery list routine. I used this opportunity to expand my knowledge of React with TypeScript.

Understanding TypeScript was the hardest part of my recent web-dev learning journey. Whenever I encounter something frustrating and difficult, I've always attempted to meet that problem head on. Therefore, I decided to create a full stack application using as much TypeScript as I possibly could.

Now I can absolutely write that TypeScript is no longer difficult or frustrating for me. As expected, I now prefer it over plain JavaScript as it provides much more information and an awesome developer experience. After about a week of using TypeScript regularly it became an very useful tool. There was a certain moment where I stopped struggling against the TypeChecker and started working with the TypeChecker.

After attempting several different offline-first with Apollo Client methods, I struggled to get offline mutations to work consistently enough to include this feature. Rather than starting over with a stack that includes more robust offline functionality, I decided to finish this app with Apollo and skip the offline mutations for now.

πŸ’– Support us

List Together is free to use and it’s code is open source on GitHub. Contributions to the project and forks are more than welcome. You can support the project or help us pay server costs by tipping us a Ko-fi