beresford211 / chutte

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Chutte.com

chutte-green-icon

Chutte.com is a reverse auction style web application. Our aim is to create a marketplace optimized for sellers to sell rare and unique items, and buyers to aquire those products at prices that appeal to them. We understand that pricing can make or break a product, our Chutte pricing algorithm removes the stressful burden of having to get pricing perfect. The price algorithm changes over the course of an items' listing, decreasing when there is no demand and holding when demand exists at a price point.


Table of Contents

  1. Demo
  2. Getting Started
  3. Usage
  4. Structure
  5. Tech Stack
  6. Webpack
  7. Troubleshooting
  8. Contributing

Demo

Check out chutte.com. Also check out our quick demo video.

Getting Started

Clone the repo and install the necessary node modules:

$ git clone https://github.com/KGB-JS/chutte.git
$ cd chutte
$ npm install                   # Install Node modules listed in ./package.json (this will be a while)

Usage

npm run build

Runs the webpack build system

npm run webserver

(by default found at localhost:3000).

Structure


   |-client
   |---public
   |-----dist
   |---src                   # Application source code
   |-----actions             # Redux action creators
   |-----Components          # Generic React Components
   |-----containers          # Components that provide context
   |-----reducers            # Redux reducers
   |-----socket              # Client side socket connections
   |-----store               # Redux store configuration
   |-server
   |---config
   |---items
   |-----itemHelpers
   |---priceSchedule
   |---socket
   |---user
   |-test                    

overall-application-structure

Tech Stack

Some technologies we used:

Using Redux DevTools

In development, Redux Devtools are enabled by default. You can toggle visibility and move the dock around using the following keyboard shortcuts:

Webpack

The webpack compiler configuration is located in ~/build/webpack. Here you'll find configurations for each environment; development, production, and development_hot. These configurations are selected based on your current NODE_ENV, with the exception of development_hot which will always be used by webpack dev server.

Note: There has been a conscious decision to keep development-specific configuration (such as hot-reloading) out of .babelrc. By doing this, it's possible to create cleaner development builds (such as for teams that have a dev -> stage -> production workflow) that don't, for example, constantly poll for HMR updates.

So why not just disable HMR? Well, as a further explanation, enabling react-transform-hmr in .babelrc but building the project without HMR enabled (think of running tests with NODE_ENV=development but without a dev server) causes errors to be thrown, so this decision also alleviates that issue.

Troubleshooting

Having an issue? Please let us know! Report it and we'll get to it as soon as possible.

Contributing

If you would like to submit a pull request, please make an effort to follow the guide in CONTRIBUTING.md.

Thanks for checking this out.

– KGB-JS / chutte (Peter, Sean, Mick and Tim)

About


Languages

Language:JavaScript 99.5%Language:CSS 0.5%Language:HTML 0.0%