This document will guide you through setting up and running the BibleVerseAbout project. Follow the steps below to get everything up and running smoothly.
Ensure you have the following installed on your system:
- Python 3.12
- pip (Python package installer)
-
Clone the repository:
git clone <repository-url> cd <repository-name>
-
Create a virtual environment:
python3.12 -m venv venv
-
Activate the virtual environment:
-
For Windows:
venv\Scripts\activate
-
For macOS and Linux:
source venv/bin/activate
-
-
Install the required dependencies:
pip install -r requirements.txt
-
Navigate to the application directory:
cd app
-
Start the application using Uvicorn:
uvicorn main:app --reload --host 127.0.0.1 --port 8000 --workers 4 --log-level debug
-
Navigate to the UI directory:
cd ui
-
Install Node.js dependencies:
npm install
-
Run the UI development server:
npm run start
Once the application is running, you can access it in your web browser at:
http://127.0.0.1:8000
-
Configuration files:
app/main.py
- Entry point of the FastAPI application.ui/package.json
- Node.js package configuration for the UI.
-
Log levels: The log level is set to
debug
for detailed logging. Adjust this level as needed.
If you wish to contribute to this project, please follow the standard GitHub workflow:
- Fork the repository.
- Create a new branch.
- Make your changes.
- Submit a pull request.
Follow these steps, and you should have the project up and running without any issues. Happy coding!