-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f1dc15f
commit 8298157
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,39 @@ | ||
# Django Celery Template | ||
|
||
[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Joel-hanson/django-celery-template) | ||
|
||
This is a template for a Django project with Celery. This project can also be run using the devcontainer in VSCode. | ||
|
||
The devcontainer library files are taken from the [vscode-dev-containers](https://github.com/microsoft/vscode-dev-containers) repository. More about devcontainers can be found [here](https://containers.dev/) and [here](https://github.com/devcontainers). | ||
|
||
## Setting up the development container | ||
|
||
### GitHub Codespaces | ||
|
||
Follow these steps to open this sample in a Codespace: | ||
|
||
1. Click the **Code** drop-down menu. | ||
2. Click on the **Codespaces** tab. | ||
3. Click **Create codespace on main** . | ||
|
||
For more information on creating your codespace, visit the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace). | ||
|
||
### VS Code Dev Containers | ||
|
||
If you already have VS Code and Docker installed, you can click the badge above or [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Joel-hanson/django-celery-template) to get started. Clicking these links will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use. | ||
|
||
Follow these steps to open this sample in a container using the VS Code Dev Containers extension: | ||
|
||
1. If this is your first time using a development container, please ensure your system meets the prerequisites (i.e. have Docker installed) in the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started). | ||
|
||
2. To use this repository, you can either open the repository in an isolated Docker volume: | ||
|
||
- Press <kbd>F1</kbd> and select the **Dev Containers: Try a Sample...** command. | ||
- Choose the "Python" sample, wait for the container to start, and try things out! | ||
> **Note:** Under the hood, this will use the **Dev Containers: Clone Repository in Container Volume...** command to clone the source code in a Docker volume instead of the local filesystem. [Volumes](https://docs.docker.com/storage/volumes/) are the preferred mechanism for persisting container data. | ||
Or open a locally cloned copy of the code: | ||
|
||
- Clone this repository to your local filesystem. | ||
- Press <kbd>F1</kbd> and select the **Dev Containers: Open Folder in Container...** command. | ||
- Select the cloned copy of this folder, wait for the container to start, and try things out! |