Skip to content

Commit

Permalink
docs: update docs with more information on how to start the project
Browse files Browse the repository at this point in the history
  • Loading branch information
AdrianFahrbach committed Dec 2, 2024
1 parent 0d72d4a commit 0ce71ea
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,28 @@
The project is still in development, we got an open beta for MacOS though.
You can join the beta by following the instructions [here](https://testflight.apple.com/join/mB7ZA6s5).

## Development
## Getting started

### Debug starting issues
To start the project you first have to install the dependencies:

```bash
npm install
npx pod-install ios
npx pod-install macos
```

After that you can start the development server.
This will launch the Metro bundler which creates the JavaScript bundle for the app.

```bash
npm start
```

Once your Metro bundler is running, you can start the app by opening the Xcode project (`Chronos.xcodeproj`) in the `macos` directory and starting the app from within Xcode.
The Xcode project contains two schemes: `Chronos-macOS` for development and `Chronos-macOS-prod` for the production build.


## Debug starting issues

Sometimes the dev environment will not start after updating packages or other external dependencies.
The reason for that is that multiple caches have to be cleared and some of those don't get cleared automatically.
Expand Down

0 comments on commit 0ce71ea

Please sign in to comment.