https://github.com/timoglastra/afj-reproduction-template
Base repository to create reproductions for AFJ bugs and issues
https://github.com/timoglastra/afj-reproduction-template
Last synced: about 2 months ago
JSON representation
Base repository to create reproductions for AFJ bugs and issues
- Host: GitHub
- URL: https://github.com/timoglastra/afj-reproduction-template
- Owner: TimoGlastra
- Created: 2022-06-30T17:26:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-30T17:56:46.000Z (almost 3 years ago)
- Last Synced: 2025-04-07T09:29:00.120Z (3 months ago)
- Language: TypeScript
- Size: 40 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AFJ Reproduction Template
Simple template repository that can be used for providing reproductions of issues and bugs.
Make sure to read the StackOverflow page on creating a minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example
## Creating a reproduction
1. Fork this repo
2. Clone the forked repo
3. Edit `index.mts` so it reproduces the issue. Add comments to the code to explain what is happening.
4. Run your program and check if the issue / bug occurs. (See [Running](#running) on how to run)
## Running
### System
1. Follow the installation guides for AFJ for your platform: https://aries.js.org/guides/getting-started/installation/nodejs
2. Install dependencies using `yarn install`
3. Run the program using `yarn start`
### Docker
1. Make sure docker is installed on your system: https://docs.docker.com/get-docker/
2. Build the image using `docker build -t afj-reproduction .`
- If you're on an ARM mac, run `docker build -t afj-reproduction -f Dockerfile.arm .` as the build step.
3. Run the program using `docker run -it --rm afj-reproduction`
You don't have to rebuild when just changing the code in the `index.mts` file. If you`re changing dependencies, or other things about the build process, you'll need to rebuild the image.