Skip to content
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.

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

Documentation: Add frontend startup instructions #32

Open
doobidoo opened this issue Feb 15, 2025 · 0 comments
Open

Documentation: Add frontend startup instructions #32

doobidoo opened this issue Feb 15, 2025 · 0 comments

Comments

@doobidoo
Copy link

The current documentation doesn't specify how to start the frontend application properly. This can lead to confusion when users try to run the application.

Suggested additions to the README:

Running the Frontend

After building the backend with cargo build --release, you need to:

  1. Start the backend server:
./target/release/deepclaude  # or deepclaude.exe on Windows
  1. In a separate terminal, start the frontend development server:
cd frontend
npm install     # Only needed first time
npm run dev     # Preferred for development

Note: While npm start is available, it requires a production build (npm run build). For development purposes, npm run dev is recommended as it provides hot reloading and better error messages.

These instructions will help users get both the backend and frontend running properly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant