https://github.com/mikesir87/container-supported-demo
https://github.com/mikesir87/container-supported-demo
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mikesir87/container-supported-demo
- Owner: mikesir87
- License: cc0-1.0
- Created: 2024-09-19T22:40:11.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-11-18T21:16:59.000Z (7 months ago)
- Last Synced: 2024-11-18T22:18:17.095Z (7 months ago)
- Language: JavaScript
- Size: 286 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Container-supported development demo
This repo provides a project to help demonstrate the idea of "container-supported development"... using containers to enhance developer productivity, even if the main app itself is _not_ in a container.
## Trying it out
This project is configured to run with the app running either natively (using Node installed on the machine) or in a container.
### Running natively
1. Ensure you have Node and yarn installed on your machine.
2. Start all of the application dependencies
```console
docker compose up
```
3. Install the app dependencies and start the main app with the following command:
```console
yarn install
yarn dev
```
#### Debugging the application
Once the app is running, you can start a debug session by using the **Debug** task in the "Run and Debug" panel.
### Running completely in containers
The `compose.native.yaml` file defines an additional `app` service that will run the application in the container.
The code is currently mounted into the app container, theoretically allowing for hot reloading. However, there is a limitation for WSL environments where the filesystem event isn't propagated, preventing nodemon from seeing the file change event.
1. Start the app using Compose, but specifying the native file
```console
docker compose -f compose.native.yaml
```
### Running tests
This project contains a few sample tests to demonstrate Testcontainer integration. To run them, follow these steps (assuming you're using Visual Studio Code):
1. Download and install the [Jest extension](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest#user-interface).
2. Open the "Testing" tab in the left-hand navigation (looks like a flask).
3. Press play for the test you'd like to run.
The *.integration.spec.js tests will use Testcontainers to launch Kafka and Postgres.
## Additional utilities
Once the development environment is up and running, the following URLs can be leveraged:
- [http://localhost:5050](http://localhost:5050) - [pgAdmin](https://www.pgadmin.org/) to visualize the database
- [http://localhost:8080](http://localhost:8080) - [kafbat](https://github.com/kafbat/kafka-ui) to visualize the Kafka cluster
The `compose.traefik.*` variants make the previous accessible using hostnames, instead of hard-to-remember ports.
- [http://db.localhost](http://db.localhost) - [pgAdmin](https://www.pgadmin.org/) to visualize the database
- [http://kafka.localhost](http://kafka.localhost) - [kafbat](https://github.com/kafbat/kafka-ui) to visualize the Kafka cluster
### Helper scripts
In the `dev/scripts` directory, there are a few scripts that can be used to interact with the REST API of the application.