Skip to content

Latest commit

 

History

History
104 lines (74 loc) · 2.4 KB

README.md

File metadata and controls

104 lines (74 loc) · 2.4 KB

Mini CMS

A headless git based CMS for managing content for guidance pages.

Features

  • Add a new page
  • Edit a page
  • Delete a page
  • View a page
  • View a page history
  • Rollback to a previous version of a page
  • Add a new version of a page
  • Edit a version of a page
  • Delete a version of a page

Getting Started

Option 1: Local Development

  1. Clone the repository
  2. Run source .venv/bin/activate
  3. Run python -m venv .venv
  4. Run pip install -r requirements.txt
  5. Run fastapi dev main.py

Option 2: Using Docker (Recommended)

  1. Clone the repository
  2. Make sure you have Docker and Docker Compose installed
  3. Build and start the containers: 
    docker compose up --build
  4. For subsequent runs, simply use: 
    docker compose up
  5. To stop the containers: 
    docker compose down

The application will be available at http://localhost:8000 in both cases.

Development with Docker

  • The application uses hot-reload, so any changes you make to the code will automatically trigger a reload
  • Application logs can be viewed using docker compose logs -f
  • To run commands inside the container: 
    docker compose exec web <command>

API

The API is available at http://localhost:8000

Collections

Get all collections

curl -X GET "http://localhost:8000/collections"

Get a collection by id

curl -X GET "http://localhost:8000/collections/{collection_id}"

Collection Content Items

Get all content items for a collection

curl -X GET "http://localhost:8000/collections/{collection_id}/content-items"

Get a content item by id

curl -X GET "http://localhost:8000/collections/{collection_id}/content-items/{content_item_id}"

Create a new content item

curl -X POST "http://localhost:8000/collections/{collection_id}/content-items" -H "Content-Type: application/json" -d '{"title": "My Content Item", "body": "This is my content item"}'

Update a content item

curl -X PUT "http://localhost:8000/collections/{collection_id}/content-items/{content_item_id}" -H "Content-Type: application/json" -d '{"title": "My Content Item", "body": "This is my content item"}'

Delete a content item

curl -X DELETE "http://localhost:8000/collections/{collection_id}/content-items/{content_item_id}"