Coin Toss Predictor API Documentation

Table of Contents

• Prerequisites:
• Getting Started
  • Installation
  • Database Setup
• Running the API

Prerequisites

Before you begin, ensure you have met the following requirements:

• Python 3.x installed.
• Pip package manager installed.
• A code editor (e.g., VSCode) for development.
• Postman or a similar tool for API testing.

Getting Started

Installation

1. Clone the repository:

   https://github.com/Pundit4Real/HNGx-s2-Rest-Api-Basic-CRUD.git

2. Create a virtual environment (recommended):

   python -m venv venv

3. Activate the virtual environment:

   - On Windows:
   venv\Scripts\activate or .\\Scripts.activate.ps1
   
   - On macOS and Linux:
   source venv/bin/activate
   

4. Install the required dependencies: pip install -r requirements.txt

Database Setup

python manage.py makemigrations

..................................

python manage.py migrate

Running the API

To run the API locally, use the following command: python manage.py runserver

The API will be available at http://localhost:8000/.

Hosted Postman Documentation

    https://documenter.getpostman.com/view/29762619/2s9Yyweeh6