Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.89 KB

README.md

File metadata and controls

50 lines (35 loc) · 1.89 KB
Raw

OpenBazaar-Client

Build Status Slack Status

You must be running the OpenBazaar backend for the client to work!

Dependencies

  • NodeJS v4.x LTS
    • Linux: sudo apt-get install nodejs-legacy
    • OSX using homebrew: brew install homebrew/versions/node4-lts
  • Ensure that npm is added to your PATH!

Running

  1. Clone the client repository into a directory of your choice:
  • git clone https://github.com/OpenBazaar/OpenBazaar-Client.git
  1. Navigate into the new folder created in (1)
  • cd OpenBazaar-Client
  1. Install the client
  • npm install
  1. Run the client
  • npm start

Remember you must be running the OpenBazaar-Server for the client to function properly. If you want to access the test network (testnet), run the server using the -t flag (e.g. $ python openbazaard.py start -t).

If the server component has not generated a GUID (which happens only once, when the server is first started), then the client will not fully start up until the GUID is created.

Current (v1 Mainnet) Release Tracker can be found here: #965

API Documentation

The client uses the following REST API calls.

Websocket API calls are yet to be documented.

Translations

Translators around the world are welcomed.

You can start translating at our Transifex project:

Many thanks!