35 lines
839 B
Markdown
35 lines
839 B
Markdown
|
# Projects
|
||
|
|
|
||
|
|
OhMyAPI organizes projects in a diretory tree.
|
||
|
|
The root directory contains the `settings.py`, which carries global configuration for your project, such as your `DATABASE_URL` and `INSTALLED_APPS`.
|
||
|
|
Each project is organized into individual apps, which in turn may provide some database models and API handlers.
|
||
|
|
Each app is isolated in its own subdirectory within your project.
|
||
|
|
You can control which apps to install and load via `INSTALLED_APPS` in your `settings.py`.
|
||
|
|
|
||
|
|
## Create a Project
|
||
|
|
|
||
|
|
To create a projects, simply run:
|
||
|
|
|
||
|
|
```
|
||
|
|
ohmyapi startproject myproject
|
||
|
|
cd myproject
|
||
|
|
```
|
||
|
|
|
||
|
|
This will create the following directory structure:
|
||
|
|
|
||
|
|
```
|
||
|
|
myproject/
|
||
|
|
- pyproject.toml
|
||
|
|
- README.md
|
||
|
|
- settings.py
|
||
|
|
```
|
||
|
|
|
||
|
|
Run your project with:
|
||
|
|
|
||
|
|
```
|
||
|
|
ohmyapi serve
|
||
|
|
```
|
||
|
|
|
||
|
|
In your browser go to: [http://localhost:8000/docs](http://localhost:8000/docs)
|
||
|
|
|