Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.08 KB

README.md

File metadata and controls

72 lines (45 loc) · 2.08 KB

MiniBloggingApp-test

A mini blogging application built using Django RestAPI.

Getting started

If you're just getting started, make sure you have the latest version of Python installed.

  • Clone the repository into a folder of your choosing and change directory into the folder MiniBloggingApp-test.
cd MiniBloggingApp-test

Then run the following commands in succession.

Activate Virtual Environment

pipenv shell

Install Requirements

pip install -r requirements.txt

The included sqlite database has all the necessary data as such theirs no need for running migrations.

Initialie the server to view the RestAPI data.

python manage.py runserver 8000

Credentials

Use the credentials below to access admin interface instead of creating another super user.

admin: clement

password: clemolumz

Fetch all blog posts

rest api home page 1

Fetch a single blog post by ID

rest api home page 2

Token

Some routes are protected using token-based authentication. All assigned tokens are visible through admin panel (http://localhost:8000/admin/authtoken/token/)

rest api home page 5

📚 Documentation

rest api home page 3

The interactive redoc documentations is here (http://localhost:8000/redoc/)

rest api home page 4

Bonus (Optional)

  • Implement caching.
  • Consume the API using a console command.
  • Write unit tests for the applica/on.
  • Use Docker to containerize the applica/on.