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.

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

docs: add precompile assets instruction to project-setup.md #518

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add precompile assets instruction to project-setup.md #518

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
16 changes: 16 additions & 0 deletions docs/contributing-guide/project-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,12 @@ You can also test the `setUser` method by using
http://localhost:3000/widget_tests?setUser=true
```

To use those URLs, you first need to compile the assets. Run:

```bash
bundle exec rails assets:precompile
```

### Docker for development

> **Note**: Follow this section only if you are trying to setup Chatwoot via docker. Else skip this.
Expand Down Expand Up @@ -118,6 +124,16 @@ docker compose run -rm rails bundle exec rake db:reset

This command essentially runs postgres and redis containers and then run the rake command inside the chatwoot server container.

#### Testing chat widget in your local environment with Docker

First,compile the assets. Run:

```bash
docker compose exec rails bundle exec rails assets:precompile
```

Then use the URLs from [#testing-chat-widget-in-your-local-environment](/docs/contributing-guide/project-setup#testing-chat-widget-in-your-local-environment)

### Running Cypress Tests

Refer the docs to learn how to write cypress specs
Expand Down