https://github.com/becklyn/ddd-workshop
https://github.com/becklyn/ddd-workshop
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/becklyn/ddd-workshop
- Owner: Becklyn
- License: mit
- Created: 2023-04-12T11:48:17.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-26T15:21:44.000Z (about 2 years ago)
- Last Synced: 2025-01-14T03:14:16.494Z (4 months ago)
- Language: TypeScript
- Size: 274 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Becklyn DDD workshop
## Preparation
1. Copy `.env.template` to `.env.local`
2. Get a GitHub token with read access to Becklyn's private docker containers.
3. Add the token to the `GH_ACCESS_TOKEN` variable in your `.env.local` file
4. Make sure you have docker installed on your machine. [Docker Desktop](https://docs.docker.com/engine/install/) is recommended (but not required) for this workshop.
5. If you are using windows: [Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install)
## Download and run our Fraym services
### MacOS / linux
The following command will:
1. download all Fraym docker containers
2. configure and run all Fraym docker containers
```sh
make docker
```
### Windows
Use WSL and then use the linux guide.
## Start the dev server for the backend app
Before you start the dev server the first time, please make sure to build all dpendency modules:
```sh
npm run build:backend
```
Run fraym migrations (from within the `/fraym` folder):
```sh
npx @fraym/crud@latest
```
```sh
npx @fraym/projections@latest
```
Run the dev server:
```sh
npm run dev
```
## Documentation of our Fraym libraries
- [@fraym/streams](https://github.com/fraym/streams-nodejs)
- [@fraym/projections](https://github.com/fraym/projections-nodejs)
- [@fraym/crud](https://github.com/fraym/crud-nodejs)
- [@fraym/auth](https://github.com/fraym/auth-nodejs)