Skip to content

Commit

Permalink
Update Local.md (#872)
Browse files Browse the repository at this point in the history
* Update Local.md

* update
  • Loading branch information
FancMa01 authored Sep 11, 2024
1 parent 8e18fad commit b4773bf
Showing 1 changed file with 33 additions and 13 deletions.
46 changes: 33 additions & 13 deletions docs/docs/Install/Local.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,17 @@ sidebar_position: 1

Local installation requires a few dependencies to be installed directly on your machine. This is the best choice for developers who want to contribute to the project, or develop integrations to customize their instance. If you intend to use this installation for production purposes, or do not want to configure your own system, we recommend a containerized installation using our [Docker Installation Guide](/docs/Install/Docker) instead.

## Step 1 - Recommended and Required Software
## System Requirements and Prerequisites

### Required
Before setting up Tombolo with Docker, ensure your system meets the following requirements:

- **CPU**: 2+ cores
- **RAM**: 4GB+ (8GB recommended for optimal performance)
- **Storage**: At least 10GB of free disk space

---

### Required Software

- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
Expand All @@ -19,13 +27,15 @@ Local installation requires a few dependencies to be installed directly on your
- App registration in Azure (Client ID and Tenant ID. For Authentication , Authorization and to Redirect after authentication). Two processes must be completed one for client application and one for server application
- Adding users to an AD group for authentication (User access control)

### Recommended
### Recommended Software and Skills

- Familiarity with basic commands associated with Command Prompt, Powershell, Terminal, or integrated terminal of your choice

- [Visual Studio Code](https://code.visualstudio.com/download) or your preferred IDE with integrated terminal.

## Step 2 - Clone the Git Repository
---

## Step 1 - Clone the Git Repository

Open a Command Prompt, Powershell, Terminal, or any other integrated terminal and navigate to your desired installation location.

Expand All @@ -35,11 +45,17 @@ Run the command below.
git clone https://github.com/hpcc-systems/Tombolo.git
```

## Step 3 - Configure Environment Variables
---

## Step 2 - Configure Environment Variables

### Server

<strong>Make a copy .env.sample file</strong> in the root of the project in your preferred text or code editor and set the following variables
<div class="important_block">
Please carefully review each variable before making any changes. Detailed explanations can be found in [Configurations](./Configurations)
</div>

Navigate to the Tombolo folder inside of the root directory of your git installation, and create a new .env file. Paste the code below and set your variables accordingly.

```bash
HOST_HOSTNAME=localhost
Expand All @@ -55,11 +71,11 @@ TENENT_ID={your azure tenant ID}
CLIENT_ID={your azure client ID}
```

Save the copied file as '.env', deleting the .sample extension
Save the file when finished.

### Client

<strong>Make a copy .env.sample filein the client-reactjs folder</strong> in your preferred text or code editor and set the following variables
From the root directory of your git installation, navigate to the Tombolo Folder, and then the Client-reactjs folder, and create a new .env file. Paste the code below and set your variables accordingly.

```bash
PORT=3001
Expand All @@ -78,13 +94,15 @@ REACT_APP_AZURE_REDIRECT_URI = http://localhost:3001
REACT_APP_AZURE_API_TOKEN_SCOPE={your api token scope}
```

Save the copied file as '.env', deleting the .sample extension
Save the file when finished.

---

## Step 4 - Run the application
## Step 3 - Run the application

### Server

Run the following commands from the root directory of your installation in your preferred terminal or integrated IDE
Run the following commands from the root directory of your git repository in your preferred terminal or integrated IDE

```bash
cd tombolo/server
Expand All @@ -100,7 +118,7 @@ The `npm run boostrap-server` command installs dependencies located in the packa

## Start the front end

Open a seperate terminal or integrated IDE, and navigate to your installation location
Open a seperate terminal or integrated IDE, and navigate to your git repository location

```bash
cd tombolo/client-reactjs
Expand All @@ -114,7 +132,9 @@ The `cd` command changes the directory you're working with.

The `npm run bootstrap-client` command installs dependencies located in the package.json file necessary for running and compiling the code. After this is finished, it will start the front end.

## Step 5 - Open the application
---

## Step 4 - Open the application

Depending on your environment, your browser may have been opened to the start page of Tombolo already, after running the
`npm start` command for the client. If not, you can reach your new installation at [http://localhost:3001/](http://localhost:3001/). If you need any further assistance, check out our [user guides](/docs/category/user-guides).

0 comments on commit b4773bf

Please sign in to comment.