-
Notifications
You must be signed in to change notification settings - Fork 2
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
c69c0aa
commit 329b063
Showing
1 changed file
with
24 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 |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Quick Start | ||
## System Requirements | ||
Ensure you have Python version 3.10 or higher installed. | ||
|
||
## Installation | ||
To install the necessary package, run the following command: | ||
```bash | ||
pip install dflowd==0.1.0b0 | ||
``` | ||
|
||
## Project Initiation | ||
Initialize your project by running: | ||
```bash | ||
dflowd init | ||
cd <PROJECT-SLUG> # enter the slug you choose for your project with the help of the previous command | ||
``` | ||
The `dflowd init` command will start an interactive `cookiecutter` process to create a project based on a predefined template. The resulting project will be a simple example template that you can customize to suit your needs. | ||
|
||
## Running Your Project | ||
To run your project, use the following command: | ||
```bash | ||
dflowd run_backend | ||
``` | ||
Note: Currently, the project runs exclusively on port 8000. |