flatmarket

Made possible By JSON Expert, the easiest way to create a web-ready API.

---

flatmarket

Flatmarket is a free, open source e-commerce platform for static websites. It is reliable, secure, and inexpensive to operate.

The platform uses Stripe for payment processing and is built on the latest web technologies like hapi, React, and Webpack.

At its core is a batteries-included CLI to help you get started quickly. Modules are also packaged individually so you can easily customize your rig.

Example

Take a minute to go try the example.

Features

• Supports many global currencies
• Subscription billing
• Address collection
• Manual charge authorization
• Bitcoin
• Mobile-ready
• and more...

Design goals

• It should cost next-to-nothing to operate.
• It should should be reliable and scalable. This is achieved by offloading expensive and complicated operations to third-party services.
• It should be secure.
• It should be easy to customize, update, and deploy.

How it works

Flatmarket is a combination of a static website paired with a proxy server for sending payments to Stripe securely. The web client and server communicate seamlessly in the background using a shared schema, represented by a JSON document. The store operator can manage inventory and store configuration simply by updating the JSON document.

Who it's for

Flatmarket isn't appropriate for every e-commerce project, but it is uniquely suited for the following situations:

• high traffic but low sales volume.
• high touch, where every transaction requires human involvement.
• sale of digital goods, made-to-order goods, or donations (where stock keeping is not required).
• any situation where low cost is a priority.

Get started

Create a schema document at ./src/flatmarket.json

{
  "info": {
    "name": "Your Store"
  },
  "products": {
    "sku_001": {
      "amount": 1000
    }
  },
  "server": {
    "host": "your-flatmarket-server.herokuapp.com"
  },
  "stripe": {
    "publishableKey": "your_publishable_key"
  }
}

Install the CLI:

npm install -g flatmarket

Start a local Flatmarket server at https://127.0.0.1:8000/:

$ flatmarket --stripe-secret-key your_stripe_secret_key --preview

Platform

• flatmarket-client A browser client for Flatmarket.
• flatmarket-example A complete example of a Flatmarket.
• flatmarket-schema A JSON schema utility for Flatmarket.
• flatmarket-server A standalone web server for Flatmarket.
• flatmarket-server-heroku A Flatmarket server for Heroku.
• hapi-flatmarket A hapi plugin for Flatmarket.

Reference

See REFERENCE.

Customization

See CUSTOMIZATION.

Contributing

See CONTRIBUTING.

License

See LICENSE.