Crypto Order book

Requirements

For development, you will only need Node.js installed on your environement.

Node

Node is really easy to install & now include NPM. You should be able to run the following command after the installation procedure below.

$ node --version
v17.0.1

$ npm --version
8.5.3

Just go on official Node.js website & grab the installer. Also, be sure to have git available in your PATH, npm or yarn might need it.

---

Install

$ git clone https://github.com/isaacpitwa/crypto-order-book.git
$ cd crypto-order-book
$ npm install

Configure app

Create .env and after Copy example.env content into it. then edit it with the url where you have setup:

• backend api

Start & watch

$ yarn dev

or

$ npm run dev

Simple build for production

$ yarn build

or

$ npm run build

Update sources

Some packages usages might change so you should run npm prune & npm install often. A common way to update is by doing

$ git pull
$ npm prune
$ npm install

To run those 3 commands you can just do

$ npm run pull

---

Languages & tools

HTML

• Used Html in the public file for the application

Typescript

• Redux toolkit is used to to manage application state.
• Axios is used to make api calls.
• Next is used for UI.
• Redux saga is use to manage side effects in the application (asynchronous actions)
• Chakra Ui is used to provide the theme of the application
• next-intl is use to provide translations in the application

CSS

• CSS is use to make custom css for individual components.