Skip to content

Commit

Permalink
Add details for local deployement (#13)
Browse files Browse the repository at this point in the history
Clean up the readme.
  • Loading branch information
arunpatro authored Nov 7, 2023
1 parent 9255306 commit f5b0659
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,22 +41,31 @@ Branches includes a specialized evaluation mechanism for the [Game of 24 puzzle]

To get started with Branches, you can either visit [code-gen-tree.vercel.app](https://code-gen-tree.vercel.app) for the hosted version or run it locally by following the instructions below.

## Running Locally
## Deploy to Vercel
```sh
npm i -g vercel
vercel
```

**Frontend (User Interface):**
## Running Locally
For local development, checkout the `local-dev` branch. This is slightly modified to use Flask to serve the code interpreter API.

Setup repo
```sh
git clone https://github.com/normal-computing/branches.git
git checkout local-dev
```

**Frontend (User Interface):**
```sh
npm install
npm run dev
```

**Backend (Code Interpreter):**

```sh
cd api
pip install -r requirements.txt
python execute.py
```
pip install -r backend/requirements.txt
python backend/interpreter.py
```

## Stay Tuned For
Expand Down

0 comments on commit f5b0659

Please sign in to comment.