mirror of
https://github.com/wowlikon/LibraryAPI.git
synced 2025-12-11 21:30:46 +00:00
README and some fixes
This commit is contained in:
17
README.md
Normal file
17
README.md
Normal 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
|
||||
Reference in New Issue
Block a user