Skip to content

Commit

Permalink
Added note to readme about using Orbstack (#92)
Browse files Browse the repository at this point in the history
Since many Mac users report memory issues when running Docker, it's recommended to use Orbstack.
It improves the overall performance and automatically picks up the Docker containers so setup is very simple.

No jira ticket associated with this checkin
  • Loading branch information
sarahkeh committed Mar 8, 2024
1 parent 3ed8632 commit 05b5ca5
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ This is a [Docker Compose](https://docs.docker.com/compose/) configuration that

**Note 3:** There is a seed file you can run to create a new user and fake data, or to add fake data to an existing user. You can do that by running `docker compose run api bundle exec rake db:seed`. If you picked the option to create a new user it will print the user information when the script is done. If you picked the option to add data to a user, it will let you know it was successfully added when it's done.

**Note 4:** Some users on MacOS have reported memory issues when running Docker, so it's recommended to install OrbStack to manage those services. Installation of Check is the same, Orbstack will automatically pick up the docker containers and they can then be managed within the app.

## Available services and container names

- Check web client (container `web`) at [http://localhost:3333](http://localhost:3333)
Expand Down

0 comments on commit 05b5ca5

Please sign in to comment.