Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pundit4real/coin-toss-predictor-api

CoinTossPredictor API Project: A user-centric gambling platform enabling logged-in users to stake amounts on coin toss predictions, offering a simple yet thrilling experience with the potential to double their stakes upon correct predictions.
https://github.com/pundit4real/coin-toss-predictor-api

Last synced: about 2 months ago
JSON representation

CoinTossPredictor API Project: A user-centric gambling platform enabling logged-in users to stake amounts on coin toss predictions, offering a simple yet thrilling experience with the potential to double their stakes upon correct predictions.

Awesome Lists containing this project

README

        

# Coin Toss Predictor API Documentation

## Table of Contents

- [Prerequisites:](#prerequisites)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Database Setup](#database-setup)
- [Running the API](#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:

```bash
https://github.com/Pundit4Real/HNGx-s2-Rest-Api-Basic-CRUD.git
2. Create a virtual environment (recommended):
```bash
python -m venv venv
3. Activate the virtual environment:
```bash
- 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
```bash
https://documenter.getpostman.com/view/29762619/2s9Yyweeh6