Doheera-kosi/BookList-API-Lab-Exercise

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Your First API Exercise

A project to create a Booklist API using plain Django.

🛠 Built With

Tech Stack

• Django
• Python

Key Features

• Creation of a Book model
• Function-based views for API endpoints
• GET and POST methods to update a database table

🚀 Live Demo

• No live demo available

💻 Getting Started

To get a local copy up and running, follow these steps:

Prerequisites

• Python installed

Setup

1. Clone the repository
2. Open the project in your preferred editor

Install

1. Install the required packages with the command: pip install -r requirements.txt

Usage

1. Run the server with the command: python manage.py runserver
2. Access the API endpoints through the specified URL (e.g., http://localhost:8000/api/books)

Run tests

1. No tests available

Deployment

No deployment instructions available

👥 Authors

• Author: Your Name

🔭 Future Features

• Adding an inventory field for books

🤝 Contributing

Contributions, issues, and feature requests are welcome!

⭐️ Show your support

If you like this project...

🙏 Acknowledgments

I would like to thank...

❓ FAQ (OPTIONAL)

• [Question_1]
  • [Answer_1]
• [Question_2]
  • [Answer_2]

📝 License

This project is licensed under the MIT License.