CareLog Documentation

Appearance

Installation Guide ​

This guide will help you install and set up CareLog on your system.

Prerequisites ​

Before installing CareLog, ensure you have the following:

  • Python 3.8 or higher - Download Python
  • pip - Python package installer (included with Python)
  • Git (optional) - For cloning the repository

Installation Steps ​

1. Clone the Repository ​

bash
git clone https://github.com/howweishan/carelog.git
cd carelog

Or download the ZIP file from the repository and extract it.

2. Create a Virtual Environment ​

It's recommended to use a virtual environment to isolate project dependencies:

Windows:

bash
python -m venv venv
.\venv\Scripts\activate

macOS/Linux:

bash
python3 -m venv venv
source venv/bin/activate

3. Install Dependencies ​

Install all required Python packages:

bash
pip install -r requirements.txt

4. Initialize the Database ​

CareLog uses a JSON-based database. On first run, it will automatically create the necessary data files in the data/ directory.

5. Run the Application ​

Start the Streamlit application:

bash
streamlit run app.py

The application will open in your default web browser at http://carelog.slimer.dev.

Default Credentials ​

CareLog comes with pre-configured test accounts for each role. You can find these in the data/data.json file or create new accounts through the system.

WARNING

Important: Change all default passwords in production environments!

Configuration ​

Environment Variables ​

You can configure CareLog using environment variables:

  • STREAMLIT_SERVER_PORT - Port to run the application (default: 8501)
  • STREAMLIT_SERVER_ADDRESS - Address to bind to (default: carelog.slimer.dev)

Streamlit Configuration ​

Customize Streamlit settings in .streamlit/config.toml:

toml
[server]
port = 8501
address = "carelog.slimer.dev"

[theme]
primaryColor = "#FF4B4B"
backgroundColor = "#FFFFFF"
secondaryBackgroundColor = "#F0F2F6"
textColor = "#262730"
font = "sans serif"

Troubleshooting ​

Port Already in Use ​

If port 8501 is already in use, specify a different port:

bash
streamlit run app.py --server.port 8502

Module Not Found Errors ​

Ensure all dependencies are installed:

bash
pip install -r requirements.txt --upgrade

Database Errors ​

If you encounter database issues, you can reset the database by deleting the data/data.json file. A new one will be created on next run.

DANGER

Warning: This will delete all data!

Next Steps ​