Skip to content

Commit

Permalink
docs: add development section in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yujiosaka committed Oct 27, 2023
1 parent 5180f47 commit 2f2fce4
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,11 +150,37 @@ See [here](https://github.com/yujiosaka/Cronyx/blob/main/examples) for the full
docker compose run test ./examples/basic/manual-job-management.ts
```

### API reference
## Development

Using Visual Studio Code and the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension, you can simplify the development environment setup process. The extension allows you to develop inside a Docker container and automatically sets up the development environment for you.

1. Install the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension in Visual Studio Code.

2. Clone the repository:

```sh
git clone https://github.com/yujiosaka/Cronyx.git
```

3. Open the cloned repository in Visual Studio Code.

4. When prompted by Visual Studio Code, click "Reopen in Container" to open the project inside the Docker container.

5. The extension will build the Docker container and set up the development environment for you. This may take a few minutes.

6. Build and run the Docker container with Docker Compose:

```sh
$ docker-compose up --build
```

This will start testing in watch mode.

## API reference

See [here](https://github.com/yujiosaka/Cronyx/blob/main/docs/API.md) for the API reference.

### Debugging tips
## Debugging tips

See [here](https://github.com/yujiosaka/Cronyx/blob/main/docs/TIPS.md) for the debugging tips.

Expand Down

0 comments on commit 2f2fce4

Please sign in to comment.