Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adiletto64 committed Aug 21, 2023
1 parent 141b48c commit 007fb1e
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 34 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
<h1 align="center">Django hogwarts 🧙‍♂️</h1>
<h4 align="center">Management commands to generate views, urls and templates!</h4>

> [!WARNING]
> Customization and documentation are incomplete
Use CLI commands to generate:
- basic create, update, list, detail views
- urlpatterns from views with REST like path urls
- form, table, detail templates (Bootstrap and django-crispy-forms by default)

[checkout docs](https://django-hogwarts.vercel.app/)

---

## Installation
Expand Down Expand Up @@ -39,7 +34,6 @@ python manage.py genurls <your-app-name>
```

Arguments:
- `--merge`, `-m` add new paths without changing existing paths in urls.py
- `--force-app-name`, `fan` override app_name in urls.py

### Generate views.py
Expand All @@ -51,6 +45,10 @@ Arguments
- `model-is-namespace`, `-mn` adds success_url with name model as [namespace](https://docs.djangoproject.com/en/4.2/topics/http/urls/#url-namespaces)

### Generate templates

**[django-crispy-forms](https://github.com/django-crispy-forms/django-crispy-forms) and
[crispy-bootstrap5](https://github.com/django-crispy-forms/crispy-bootstrap5) packages are required**

```
python manage.py gentemplates <your-app-name>
```
6 changes: 3 additions & 3 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"devDependencies": {
"vitepress": "1.0.0-rc.4"
},
"scripts": {
"docs:dev": "vitepress dev",
"docs:build": "vitepress build",
"docs:preview": "vitepress preview"
},
"devDependencies": {
"vitepress": "1.0.0-rc.4"
}
}
53 changes: 28 additions & 25 deletions docs/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 007fb1e

Please sign in to comment.