Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.39 KB

Readme.md

File metadata and controls

38 lines (29 loc) · 1.39 KB
Raw

HamsterList

A React-based shared shopping list.

Clients

This repository contains a server and a web-based client. There is also a cli client. If you wish to develop your own client, consider the API documentation.

Developing

This section describes how to set up and run HamsterList locally on your computer.

  1. Install required tools
    1. node
    2. yarn
  2. Check out this repo
  3. Run ./install.sh to download required node packages
  4. HamsterList has three components shared, server and client. You need to start a watcher for each of them to rebuild and restart when you perform changes:
    1. shared: cd shared; yarn watch
    2. server: cd server; yarn start
    3. client: cd client; yarn start
  5. You should now be able to access HamsterList on http://localhost:3000

Deploying

You can deploy your own HamsterList instance.

  1. Install required tools
    1. node
    2. yarn
  2. Check out this repo
  3. Run ./install.sh to download required node packages
  4. Run ./production_build.sh to build for production
  5. Run the server: node server/build/index.js, then stop it. This generates a config file.
  6. Edit the file config.json and set the value of "host" to your domain
  7. Run the server again