https://github.com/jonra1993/mock-social-api
Mock APIs Arntreal
https://github.com/jonra1993/mock-social-api
fastapi pydantic pydantic-v2
Last synced: over 1 year ago
JSON representation
Mock APIs Arntreal
- Host: GitHub
- URL: https://github.com/jonra1993/mock-social-api
- Owner: jonra1993
- License: mit
- Created: 2024-10-04T22:09:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-15T22:50:20.000Z (over 1 year ago)
- Last Synced: 2025-01-11T09:18:53.536Z (over 1 year ago)
- Topics: fastapi, pydantic, pydantic-v2
- Language: Python
- Homepage: https://mock-social-api.vercel.app/docs
- Size: 151 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mock Social API
## Overview
This project is built using FastAPI and allows you to track user activity and check follow status on Instagram accounts.
## Prerequisites
Before running the project, you need to have [Poetry](https://python-poetry.org/docs/#installation) installed. Poetry is a dependency management tool for Python.
### Install Poetry
To install Poetry, follow the instructions provided on their [official installation page](https://python-poetry.org/docs/#installation).
For most systems, you can use the following command:
```bash
curl -sSL https://install.python-poetry.org | python3 -
```
After installation, ensure that Poetry is in your PATH:
```bash
export PATH="$HOME/.local/bin:$PATH"
```
## Getting Started
1. **Clone the repository** (if you haven't already):
```bash
git clone https://github.com/jonra1993/mock-social-api.git
cd mock-social-api
```
2. **Install dependencies**:
```bash
poetry install
```
3. **Activate the Poetry environment**:
```bash
poetry shell
```
4. **Run the FastAPI project**:
Use the following command to start the FastAPI server:
```bash
fastapi dev mock_social_api/main.py
```
5. **Access the API**:
Open your web browser and go to [http://localhost:8000/docs](http://localhost:8000/docs) to access the FastAPI documentation and test the endpoints.
## Project Structure
- `mock_social_api/`: Contains the main application logic.
- `main.py`: Entry point for the FastAPI application.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.