README and some fixes

This commit is contained in:
2025-05-27 13:09:50 +03:00
parent 6055467e97
commit cedb471722
5 changed files with 25 additions and 5 deletions

17
README.md Normal file
View File

@@ -0,0 +1,17 @@
# Book API
## Installation
1. Clone the repository: `git clone https://github.com/yourusername/bookapi.git`
2. Navigate to the project directory: `cd bookapi`
3. Copy and configure environment variables: `cp .env.example .env`
4. Build docker-compose: `docker-compose build`
5. Run the application: `docker-compose up`
## Usage
## TODO
* Usage instructions
* Split models for api and db
* Add documentation for API endpoints
* Add alembic migrations
* Add tests