DRF Blog Bridger

Introduction

DRF Blog Bridger is a simple tool that allows Django Rest Framework Developers to set up a simple blog API without worrying about the underlying code. The tool takes care of things like CRUD operations for blog posts, as well as the comment feature for each post.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Testing
• API Documentation
• Contributing
• License

Getting Started

The following instructions will help you install DRF Blog Bridger on your local system and have it running. You can read the full documentation on Read The Docs.

Prerequisites

• Python 3.8 or higher
• Pip
• Django Rest Framework

Installation and Setup

1. Install the package with:

   pip install drf_blog_bridger

2. Include the following settings in your settings.py file:

   INSTALLED_APPS = [
   
       'blog_bridger_drf',
       'rest_framework',
   ]
   
   REST_FRAMEWORK = {
       'DEFAULT_PERMISSION_CLASSES':[
           'rest_framework.permissions.IsAuthenticatedOrReadOnly',
       ]
   }

3. Include the following in your project-level urls.py file:

   path('api/posts/', include('blog_bridger_drf.urls')),

4. Run python manage.py migrate to migrate the models into your database. You should read the API reference to understand how the endpoints work.

Contributing

Contributions are welcome! Feel free to open a pull request right away.

License

This project is licensed under the MIT License - see the LICENSE file for details