Set up a local Data Formulator development environment

How to set up your local machine.

Prerequisites

Create a Virtual Environment

python -m venv venv
.\venv\Scripts\activate

Install Dependencies
```
pip install -r requirements.txt
```
Run
- Windows
```
.\local_server.bat
```
- Unix-based
```
.\local_server.sh
```

Install NPM packages
```
yarn
```
Development mode

Run the front-end in development mode using, allowing real-time edits and previews:
```
yarn start
```
Open http://localhost:5173 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.

Build the frontend and then the backend

Compile the TypeScript files and bundle the project:
```
yarn build
```
This builds the app for production to the py-src/data_formulator/dist folder.

Then, build python package:
```
pip install build
python -m build
```
This will create a python wheel in the dist/ folder. The name would be data_formulator-<version>-py3-none-any.whl
Test the artifact

You can then install the build result wheel (testing in a virtual environment is recommended):
```
# replace <version> with the actual build version. 
pip install dist/data_formulator-<version>-py3-none-any.whl 
```
Once installed, you can run Data Formulator with:
```
data_formulator
```
or
```
python -m data_formulator
```
Open http://localhost:5000 to view it in the browser.