Add basic readme

This commit is contained in:
Tim Kächele 2024-02-25 11:58:32 +01:00
parent eb6363e121
commit ff11faef92
2 changed files with 37 additions and 0 deletions

BIN
.screenshots/ui.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 524 KiB

37
README.md Normal file
View File

@ -0,0 +1,37 @@
# Rex UI
Rex UI is a simple ui for the [ruby exchange (rex)](https://git.timkaechele.me/timkaechele/rex)
## System dependencies
- Node v19.3.0, this was the node version used to develop the project, newer versions should work as well.
## Installation
Install the dependencies
```bash
$ npm install
```
## Running the project
Start a server
```bash
$ npm run server
```
The ui tries to connect to the exchange on `localhost:8080`. If you run the exchange on a different host/port you have to change the url in `src/app.jsx`
## Building the project
You can build all dependencies using the following script
```bash
$ npm run build
```
## Screenshots
![UI Screenshot](./.screenshots/ui.png)