Skip to content

Scribe is a Django-based RESTful API application for managing a blog. It allows us to create, retrieve, update, and delete posts, assign categories and users to posts and filter and search posts by title, description, and category.

Notifications You must be signed in to change notification settings

diina-gh/django-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scribe

Scribe is a Django-based RESTful API application for managing a blog.

Features

  • Create, retrieve, update, and delete posts
  • Assign categories and users to posts
  • Filter and search posts by title, description, and category
  • Pagination support for listing posts

Prerequisites

  • Python 3.x
  • Django 3.x
  • Django REST Framework 3.x

Installation

  1. Clone the repository:
$ git clone https://github.com/diina-gh/django-api.git
  1. Create a virtual environment:
$ python3 -m venv env
  1. Activate the virtual environment:
$ source env/bin/activate
  1. Install the required dependencies:
$ pip install -r requirements.txt
  1. Apply the database migrations:
$ python manage.py migrate
  1. Start the development server:
$ python manage.py runserver
  1. Access the API at http://localhost:8000/api/

Configuration

The main configuration files are:

  • settings.py: Contains the Django project settings
  • urls.py: Defines the API endpoint URLs and their associated views

About

Scribe is a Django-based RESTful API application for managing a blog. It allows us to create, retrieve, update, and delete posts, assign categories and users to posts and filter and search posts by title, description, and category.

Topics

Resources

Stars

Watchers

Forks

Languages