Yalemi API is a backend service for a Twitter-like social network. It is built with FastAPI and SQLModel, providing a robust and efficient platform for social interactions.
- User authentication and authorization with OAuth2.
- CRUD operations for user profiles.
- CRUD operations for posts (referred to as "May").
- Real-time updates with WebSockets (if applicable).
- Python 3.8 or higher
- PostgreSQL
-
Clone the repository:
git clone https://github.com/consdotpy/yalemi-api.git
-
Install the dependencies:
pip install -r requirements.txt
-
Set up your environment variables in a
.env
file. Refer to.env.example
for required variables. -
Run the server:
uvicorn app.main:app --reload
Visit http://localhost:8000/docs
for interactive API documentation.
WIP
WIP
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
This project is licensed under the MIT License - see the LICENSE file for details.
- FastAPI and SQLModel for providing a great foundation for building robust APIs.
- The open-source community for continuous inspiration and resources.