Skip to content

Commit 42672ee

Browse files
devcontainer instructions
1 parent aba472c commit 42672ee

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,37 @@ git checkout -b my_new_branch
2626

2727
Simple!
2828

29+
## Development Environment
30+
Want to get started quickly? Use [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers). They provide a consistent, pre-configured development environment, ensuring you're ready to go without lengthy setup.
31+
32+
### Prerequisites:
33+
34+
* [**Docker**](https://www.docker.com/) (ensure Docker Desktop or your Docker daemon is running)
35+
* [**Visual Studio Code**](https://code.visualstudio.com/)
36+
* [**VS Code Dev Containers Extension**]()
37+
38+
### Getting Started:
39+
40+
1. **Open in Dev Container:** Open the project folder in VS Code. Click "Reopen in Container" when prompted (or use the Command Palette).
41+
42+
2. **Initial Setup:** Once the container is ready, open a terminal and run:
43+
```bash
44+
make devcontainer-setup
45+
```
46+
This command installs requirements, runs migrations, and populates the database.
47+
48+
### Running Server (Inside the Dev Container):
49+
50+
* Run Development Server (Django's built-in):
51+
```bash
52+
make serve
53+
```
54+
55+
* Run Development Server (Gunicorn):
56+
```bash
57+
make serve-gunicorn
58+
```
59+
2960
## Financial contributions
3061
3162
We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/pokeapi).

0 commit comments

Comments
 (0)