diff --git a/README.md b/README.md index cbe254f56..d053ca6e8 100644 --- a/README.md +++ b/README.md @@ -74,61 +74,48 @@ cargo run --release -p cli node ## How to launch the UI: -### Prerequisites +## Prerequisites -The following tools are required to launch the UI: +### 1. Node.js v20.11.1 -- Node.js -- npm -- Angular CLI - -Here are the steps to install these tools: - -#### 1. Node.js - -Download and install [Node.js](https://nodejs.org/) for your OS, which includes Node Package Manager (npm). - -- After installing Node.js, verify your installation: - - ```bash - node -v - ``` - This command should print the version number of your Node.js installation. - -#### 2. npm -- Verify that you are running a version of npm that is at least 6.x.x or higher: +#### MacOS +```bash +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" +brew install node@20.11.1 +``` - ```bash - npm -v - ``` - This command should print the version number of your npm installation. +#### Linux +```bash +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash +source ~/.bashrc +nvm install 20.11.1 +``` -#### 3. Angular CLI -- Install the Angular CLI globally: +#### Windows +Download [Node.js v20.11.1](https://nodejs.org/) from the official website, open the installer and follow the prompts to complete the installation. - ```bash - npm install -g @angular/cli - ``` - This command installs the Angular CLI globally on your system. -- Verify your Angular CLI installation: +### 2. Angular CLI v16.2.0 +```bash +npm install -g @angular/cli@16.2.0 +``` - ```bash - ng version - ``` - This command should print the version number of your Angular CLI installation. +### 3. Installation +Open a terminal and navigate to this project's root directory -### Steps (for any OS) +```bash +cd PROJECT_LOCATION/openmina/frontend +``` +Install the dependencies +```bash +npm install +``` -Open the command line, navigate to the openmina directory and then run +## Run the application -``` sh -cd frontend -npm install +```bash npm start ``` -Open your browser and navigate to [http://localhost:4200](http://localhost:4200). - ## Repository Structure - [core/](core) - Provides basic types needed to be shared across different diff --git a/frontend/README.md b/frontend/README.md index 8cc1446f3..70f0a9ac5 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -4,9 +4,7 @@ This is a simple Angular application that will help you to see the behaviour of ## Prerequisites -### 1. Node.js - -Install Node.js v20.11.1: +### 1. Node.js v20.11.1 #### MacOS ```bash @@ -24,25 +22,24 @@ nvm install 20.11.1 #### Windows Download [Node.js v20.11.1](https://nodejs.org/) from the official website, open the installer and follow the prompts to complete the installation. -### 2. Angular CLI -Install the Angular CLI v16.2.0 globally: - - ```bash - npm install -g @angular/cli@16.2.0 - ``` - -## Installation +### 2. Angular CLI v16.2.0 +```bash +npm install -g @angular/cli@16.2.0 +``` -1. Open a terminal and navigate to this project's root directory. -2. Install project dependencies: +### 3. Installation +Open a terminal and navigate to this project's root directory - ```bash - npm install - ``` -3. Run the application: +```bash +cd PROJECT_LOCATION/openmina/frontend +``` +Install the dependencies +```bash +npm install +``` - ```bash - npm start - ``` +## Run the application -Next time you want to run the application, just run `npm start` again. +```bash +npm start +```