Skip to content

chore: Update README.md with instructions for running the project loc… #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emoltz merged 1 commit into from
May 31, 2024
Merged

chore: Update README.md with instructions for running the project loc… #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# Path Analysis Tool

React + TypeScript + Vite + SWC (rust compiler)
React + TypeScript + Vite + SWC (with Rust compiler)

## How to Run Locally
1. This uses `bun` to run, build, and deploy. You will need to have the `bun` command installed. You can install it by running
```npm install -g @bun/cli```
2. Run ```bun install``` to download the necessary dependencies.
3. You will need a local .env file with secret variables. Reach out to Ethan for these.
4. Run ```bun run dev``` to start the development server.

This used `Bun` to run, build, and deploy. Use
```bun install``` and then ```bun run dev``` to start the development server.

---

Expand Down