Welcome to the Book Inventory Platform! This application allows users to manage their book collections and shopping carts. Below you'll find instructions on how to set up and run the project locally, as well as information about the deployed application.
You can access the live application at: https://book-inventory-platform.onrender.com
To run the project locally, follow these steps:
- Python 3.11.4 or later
- Pip (Python package installer)
-
Clone the repository:
git clone https://github.com/your-repository-url.git cd your-repository-directory
-
Install the required Python packages:
pip install -r requirements.txt
-
Set up the database:
flask db init flask db migrate flask db upgrade
-
Start the application:
gunicorn run:app
Ensure you have the following environment variables set:
SECRET_KEY
: A secret key for session management. Can be generated automatically.GOOGLE_BOOKS_API_KEY
: Your Google Books API key.DATABASE_URL
: The connection string for your database, provided by Render.
Below is a screenshot of the current database schema:
This project is deployed using Render. The render.yaml
configuration file used for deployment is as follows:
services:
- type: web
name: book-inventory-platform
env: python
buildCommand: |
pip install -r requirements.txt
flask db init
flask db migrate
flask db upgrade
startCommand: gunicorn run:app
envVars:
- key: PYTHON_VERSION
value: 3.11.4
- key: SECRET_KEY
generateValue: true
- key: GOOGLE_BOOKS_API_KEY
sync: false
- key: DATABASE_URL
fromDatabase:
name: book_inventory_db
property: connectionString
databases:
- name: book_inventory_db
databaseName: book_inventory
user: book_inventory
Feel free to submit issues or pull requests to improve the project. Contributions are welcome!
This project is licensed under the MIT License - see the LICENSE file for details.