social-network

Simple set of REST APIs to operate users, that can perform various actions on posts that they create

Table of Contents

• Installation
• Usage
• API Endpoints
• Swagger Documentation
• Linting
• Automated Bot

Installation

1. Clone the repository:

   git clone https://github.com/staaceyD/social-network

2. Install dependencies and activate virtural env:

   poetry install
   poetry shell

3. Make sure you are in the main folder, i.e. 'social_network' and apply database migrations:

   python manage.py migrate

Usage

Run the development server:

```bash
python manage.py runserver
```

Your APIs will be accessible at http://127.0.0.1:8000/.

API Endpoints

The full list of endpoints can be found in openapi.yml file

Swagger Documentation

The Swagger documentation for this API is generated using drf-spectacular.

Visit the Swagger UI at: http://127.0.0.1:8000/schema/swagger-ui/

To download the schema visit http://127.0.0.1:8000/schema

Or, explore the JSON schema at: http://127.0.0.1:8000/schema/swagger/?format=openapi

To generate updated file use the following command:

python manage.py spectacular --color --file openapi.yml

Linting

It's highly recommended that you install the pre-commit hook - this will automatically lint your code each time you commit.

From the root of the project do this:

brew install pre-commit pre-commit install

Automated Bot

This project has automated bot. It is a tool designed to showcase the capabilities of a project through predefined rules. Configured to read rules from a customizable config file

Should be executed as a regular python file from main folder:

python automated_bot/bot.py

Note: the bot should be run INSIDE virtual env