Browse Source

Create README.md

pull/1/head
Slixe GitHub 3 years ago
parent
commit
ec35ba0eff
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 69 additions and 0 deletions
  1. +69
    -0
      README.md

+ 69
- 0
README.md View File

@@ -0,0 +1,69 @@
# DERO Benchmarks

DERO Benchmarks allows you to list each user's benchmarks. Admins can manually confirm/delete each user's benchmarks from a dedicated page.

The backend part uses the [Paladin Framework](https://github.com/paladin-framework/paladin) and is made in Java.

The frontend part uses [VueJS Framework](https://vuejs.org/) and [Vuetify](https://vuetifyjs.com) and can be found in [dero-benchmark-vue](https://github.com/Slixe/dero-benchmarks/tree/master/dero-benchmark-vue) folder.

# How to start
To start, you will need to build the backend and frontend separately.

## Backend
First, you must have a java version higher or equal to Java 8.
To compile the backend, do the following command:
```
gradlew fatJar
```
The executable jar file will be found in `build/libs/` folder.
To execute it, all you'll have to do is:
```
java -jar dero-benchmarks.jar
```

Edit the `config.json` file to put the port on which the server should listen.

### Create User
Edit the file `admins.json`, an example is created in it.
If you want the application to hash your password, replace `"hashedPassword"` with `"password"`.

Example of `admins.json`:
```json
[
{
"username": "Slixe",
"password": "password123",
"salt": "salt123"
}
]
```

## Frontend
First you will need to change the value of `Vue.prototype.$api` with your API address (so the IP address/domain name where your backend is running) in the `src/main.js` file.

Then, to build the frontend:
```
yarn run build
```
The result will be available in the `dist` folder and all you have to do is move its content to a web server.

# Screenshots
Some screenshots of the current design.

### Index
![](https://i.imgur.com/r3T2p0J.png)

### Submit
![](https://i.imgur.com/JoLyor7.png)

### Login
![](https://i.imgur.com/jmUFFJw.png)

### Unconfirmed Benchmarks (admin page)
![](https://i.imgur.com/ZZe0Atv.png)


## DERO
```
dERokevAZEZVJ2N7o39VH81BXBqX9ojtncnPTDMyiVbmYiTXQY93AUCLcor9xsWCKWhYy25ja89ikZWXWab9kXRB7LYfUmbQyS
```

Loading…
Cancel
Save