https://github.com/app-generator/core-django-api-gen
Django API Generator - Complete Sample | AppSeed
https://github.com/app-generator/core-django-api-gen
appseed django-api django-starter django-template
Last synced: 3 months ago
JSON representation
Django API Generator - Complete Sample | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/core-django-api-gen
- Owner: app-generator
- Created: 2022-10-22T07:27:17.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-22T15:25:35.000Z (about 3 years ago)
- Last Synced: 2025-04-06T18:12:46.901Z (8 months ago)
- Topics: appseed, django-api, django-starter, django-template
- Language: Python
- Homepage: https://github.com/app-generator/django-api-generator
- Size: 13.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# [Django API Generator](https://github.com/app-generator/django-api-generator) `Sample`
Minimal **Django** project with `Docker` support - actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.
> Features - see **[video](https://www.youtube.com/watch?v=fkjvhFejEv8)** presentation
- ✅ `Up-to-date Dependencies`
- ✅ `Docker`
- ✅ Integrates [API Generator](https://github.com/app-generator/django-api-generator) Library for Django
## ✨ Start the app in Docker
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/core-django.git
$ cd core-django
```
> 👉 **Step 2** - Start the APP in `Docker`
```bash
$ docker-compose up --build
```
Visit `http://localhost:5085` in your browser. The app should be up & running.
## Manual Build
> 👉 Download the code
```bash
$ git clone https://github.com/app-generator/core-django-api-gen.git
$ cd core-django-api-gen
```
> 👉 Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt
```
> 👉 Set Up Database
```bash
$ python manage.py makemigrations
$ python manage.py migrate
```
> 👉 Create SuperUser
```bash
$ python manage.py createsuperuser
```
> 👉 Generate the API for `Books` model
```bash
$ python manage.py generate-api
```
> 👉 Start the app
```bash
$ python manage.py runserver
```
At this point, the app runs at `http://127.0.0.1:8000/` and the API is usable `http://127.0.0.1:8000/api/books/`
---
[Django API Generator](https://github.com/app-generator/django-api-generator) `Sample` - Minimal **Django** starter provided by **[AppSeed](https://appseed.us/)**