Skip to content

Commit 429c3f5

Browse files
authored
Add README for .devcontainer folder (run-llama#46)
* add README for .devcontainer folder * spelling * spelling * typo
1 parent fc04aa8 commit 429c3f5

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

.devcontainer/README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# SEC Insights Dev Container
2+
3+
This dev container configuration sets up a development environment that is specifically configured for this project.
4+
5+
This is useful in getting the project setup faster by having many of the system dependencies already pre-installed.
6+
7+
## How do I use this?
8+
9+
You can either click this button to open the dev container on a Github Codespace:
10+
11+
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/run-llama/sec-insights)
12+
13+
Or you can spin up the dev container up locally using [VS Code's dev container feature](https://code.visualstudio.com/docs/devcontainers/create-dev-container#_create-a-devcontainerjson-file).
14+
15+
## What are the benefits of using this?
16+
* System level dependencies are pre-installed
17+
* Project-specific python version
18+
* Other dependencies like `wkhtmltopdf` & `s3fs` are pre-installed
19+
* Uses the same base Docker image as what's used for the production service
20+
* So higher fidelity between your dev environment and prod environment.
21+
22+
## Are there any downsides to using this?
23+
One downside is that when you're using the dev container via Github Codespaces, that service isn't entirely free. There's a free tier limit after which Github Codespace usage is paid.
24+
Also, if you're running the dev container locally via the VS Code dev container feature, you may find that Docker can take up quite a bit of storage space on your machine. Make sure you have the necessary storage space.
25+

0 commit comments

Comments
 (0)