|
1 | | -# Openmina Frontend |
| 1 | +# Mina Rust Frontend |
2 | 2 |
|
3 | | -This is a simple Angular application that will help you to see the behaviour of |
4 | | -your local rust based mina node. |
| 3 | +The Mina Rust frontend is an Angular-based web dashboard for monitoring and |
| 4 | +debugging Mina Rust nodes. |
| 5 | +For complete documentation, please see: |
5 | 6 |
|
6 | | -## Prerequisites |
| 7 | +**[Frontend Dashboard Documentation](https://o1-labs.github.io/mina-rust/docs/developers/frontend)** |
7 | 8 |
|
8 | | -### 1. Node.js v23.1.0 |
| 9 | +## License |
9 | 10 |
|
10 | | -#### MacOS |
11 | | - |
12 | | -```bash |
13 | | -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" |
14 | | - |
15 | | -``` |
16 | | - |
17 | | -#### Linux |
18 | | - |
19 | | -```bash |
20 | | -curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash |
21 | | -source ~/.bashrc |
22 | | -nvm install 23.1.0 |
23 | | -``` |
24 | | - |
25 | | -#### Windows |
26 | | - |
27 | | -Download [Node.js v23.1.0](https://nodejs.org/) from the official website, open |
28 | | -the installer and follow the prompts to complete the installation. |
29 | | - |
30 | | -### 2. Angular CLI v19.2.14 |
31 | | - |
32 | | -```bash |
33 | | -npm install -g @angular/ [email protected] |
34 | | -``` |
35 | | - |
36 | | -### 3. Installation |
37 | | - |
38 | | -Open a terminal and navigate to this project's root directory |
39 | | - |
40 | | -```bash |
41 | | -cd PROJECT_LOCATION/openmina/frontend |
42 | | -``` |
43 | | - |
44 | | -Install the dependencies |
45 | | - |
46 | | -```bash |
47 | | -npm install |
48 | | -``` |
49 | | - |
50 | | -## Run the application |
51 | | - |
52 | | -```bash |
53 | | -npm start |
54 | | -``` |
55 | | - |
56 | | -# Using O1JS wrapper |
57 | | - |
58 | | -as of now, o1js is not prepared to work with Angular, therefore we need to use |
59 | | -the wrapper that is provided in the `src/assets/o1js` folder. This wrapper is a |
60 | | -simple javascript webpack based application that will allow us to use the o1js |
61 | | -library in our Angular application. |
62 | | - |
63 | | -How to use it: |
64 | | - |
65 | | -1. Open a terminal and navigate to the `src/assets/o1js` folder |
66 | | -2. Install the dependencies |
67 | | - |
68 | | -```bash |
69 | | -npm install |
70 | | -``` |
71 | | - |
72 | | -3. Build the wrapper |
73 | | - |
74 | | -```bash |
75 | | -npm run build-o1jswrapper |
76 | | -``` |
77 | | - |
78 | | -4. That's it. Now you can use your code from o1js-wrapper inside the Angular |
79 | | - application by using `BenchmarksWalletsZkService => o1jsInterface` |
| 11 | +[Apache-2.0](LICENSE) |
0 commit comments