Skip to content

Commit 336cd6b

Browse files
authored
Add running the bot section to contributing guide (#192)
1 parent 3116f80 commit 336cd6b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,23 @@ To install the dependencies, run the following command:
88
python -m pip install -r '.[test,lint]'
99
```
1010

11+
### Running a local instance
12+
13+
You can run sam locally in your terminal by running the following command:
14+
```bash
15+
sam run -v slack
16+
```
17+
18+
You may also use Docker to run Sam. To do so, first ensure you have Docker and Docker Compose installed.
19+
20+
```bash
21+
cp .env.example .env
22+
# Edit the .env file to set your environment variables
23+
docker-compose up --build
24+
```
25+
26+
### Running Tests
27+
1128
To run the tests, run the following command:
1229

1330
```bash

0 commit comments

Comments
 (0)