-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c566828
commit 7e7fc64
Showing
1 changed file
with
30 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,59 +1,51 @@ | ||
# Running Data-River Locally | ||
# Running Locally | ||
|
||
To contribute to Data-River or experiment with its features, you can run the platform locally on your machine. This guide will walk you through the steps to get Data-River up and running. | ||
|
||
## Prerequisites | ||
|
||
Before you begin, make sure you have the following installed: | ||
|
||
- **Node.js** (version 20 or higher) | ||
- **pnpm** (package manager) | ||
- **Git** | ||
{% embed url="https://www.youtube.com/watch?ab_channel=SoftFlow&v=6A1-OiSFK7M" %} | ||
|
||
## Steps to Run Locally | ||
## Prerequisites | ||
|
||
1. **Clone the Repository** | ||
Start by cloning the Data-River repository to your local machine: | ||
Before you begin, make sure you have the following installed: | ||
|
||
```bash | ||
git clone https://github.com/softflow24/data-river.git | ||
cd data-river | ||
``` | ||
* **Node.js** (version 20 or higher) | ||
* **pnpm** (package manager) | ||
* **Git** | ||
|
||
2. **Install Dependencies** | ||
Install the required dependencies using `pnpm` (we use pnpm workspaces so you need to install it): | ||
## Steps to Run Locally | ||
|
||
```bash | ||
pnpm install | ||
``` | ||
1. **Clone the Repository**\ | ||
Start by cloning the Data-River repository to your local machine: | ||
|
||
3. **Run the Development Server** | ||
Once the dependencies are installed, you can start the development server: | ||
```bash | ||
git clone https://github.com/softflow24/data-river.git | ||
cd data-river | ||
``` | ||
2. **Install Dependencies** Install the required dependencies using `pnpm` (we use pnpm workspaces so you need to install it): | ||
|
||
```bash | ||
pnpm run dev | ||
``` | ||
```bash | ||
pnpm install | ||
``` | ||
3. **Run the Development Server** Once the dependencies are installed, you can start the development server: | ||
|
||
This will start the local server, and you can access Data-River by navigating to `http://localhost:5173/` in your browser. | ||
```bash | ||
pnpm run dev | ||
``` | ||
|
||
4. **Build the Project** (Optional) | ||
If you need to build the project for production or testing, you can use: | ||
This will start the local server, and you can access Data-River by navigating to `http://localhost:5173/` in your browser. | ||
4. **Build the Project** (Optional) If you need to build the project for production or testing, you can use: | ||
|
||
```bash | ||
pnpm run build | ||
``` | ||
```bash | ||
pnpm run build | ||
``` | ||
|
||
## Troubleshooting | ||
|
||
- **Missing Dependencies**: Ensure that all dependencies are installed properly by running `pnpm install`. | ||
- **Port Conflicts**: If you encounter port conflicts, make sure `http://localhost:5173/` is not already in use. | ||
|
||
--- | ||
|
||
## What's Next? | ||
* **Missing Dependencies**: Ensure that all dependencies are installed properly by running `pnpm install`. | ||
* **Port Conflicts**: If you encounter port conflicts, make sure `http://localhost:5173/` is not already in use. | ||
|
||
Once you have Data-River running locally, check out our guide on block development to start creating or modifying blocks. | ||
|
||
- [Block Development](development/block-development.md) | ||
|
||
--- | ||
*** |