Update docs/portfolio/patient-intake-output-recorder.md

docs/portfolio/index.md

@@ -4,18 +4,21 @@ Welcome to my portfolio! This is where I showcase my projects.
 
 ## Projects
 
-### [Patient Input/Output Recorder](./patient-input-output-recorder.md)
+### [Patient Intake/Output Recorder](./patient-intake-output-recorder.md)
 
-:   A tool for healthcare professionals to monitor patients' health parameters efficiently.
+: A tool for healthcare professionals to monitor patients' health parameters
+efficiently.
 
 ### [Typing Contest Discord Bot](./typing-contest-bot.md)
 
-:   This is a Discord bot built with discord.py to facilitate typing contests in a server.
+: This is a Discord bot built with discord.py to facilitate typing contests in a
+server.
 
 ### [Permission Tree](./permission-tree.md)
 
-:   A tree structure that manages permissions and allows moving subtrees.
+: A tree structure that manages permissions and allows moving subtrees.
 
 ### [Mkdocs Material Template](./mkdocs-material-template.md)
 
-:   This template uses MkDocs with the Material theme to create elegant, responsive, and well-structured documentation for your projects.
+: This template uses MkDocs with the Material theme to create elegant,
+responsive, and well-structured documentation for your projects.

docs/portfolio/patient-intake-output-recorder.md

@@ -1,40 +1,135 @@
-# Patient Intake/Output (I/O) Recorder
+<h1 align="center">Patient Intake/Output (I/O) Recorder</h1>
 
-[Patient Side](https://lifeadventurer.github.io/patient-intake-output-recorder/patient/)
-[Monitor Side](https://lifeadventurer.github.io/patient-intake-output-recorder/monitor/)
+<hr>
 
-This project is a simple tool for recording and tracking essential health parameters of patients. It provides a user-friendly interface for healthcare professionals to log various health metrics, including food intake, water consumption, urine volume, defecation frequency, and weight, along with corresponding timestamps for each entry. This information can be valuable for healthcare professionals to monitor and analyze the health status of patients over time.
+<h4 align="center">
+  <a href="https://lifeadventurer.github.io/patient-intake-output-recorder/getting-started/#installation">Install</a>
+  ·
+  <a href="https://lifeadventurer.github.io/patient-intake-output-recorder/getting-started/#configuration">Configure</a>
+  ·
+  <a href="https://lifeadventurer.github.io/patient-intake-output-recorder">Docs</a>
+</h4>
 
-Uses [Poetry](https://github.com/python-poetry/poetry) for dependency management and includes, ruff and pre-commit for linting and formatting.
+This project is a simple tool for recording and tracking essential health
+parameters of patients. It provides a user-friendly interface for healthcare
+professionals to log various health metrics, including food intake, water
+consumption, urine volume, defecation frequency, and weight, along with
+corresponding timestamps for each entry. This information can be valuable for
+healthcare professionals to monitor and analyze the health status of patients
+over time.
+
+Uses [Poetry](https://github.com/python-poetry/poetry) for dependency management
+and includes, ruff and pre-commit for linting and formatting.
 
 ## Importance for Kidney Disease Management
 
-In particular, it plays a crucial role in managing conditions such as kidney disease, where strict control over water intake is essential for maintaining health and preventing complications.
+In particular, it plays a crucial role in managing conditions such as kidney
+disease, where strict control over water intake is essential for maintaining
+health and preventing complications.
 
 ## Getting Started
 
-1. Set your token: First, navigate to the `config.json` file located in the `backend` directory. Update the file by replacing `{your_token_here}` with your actual token in the following format:
+This guide will walk you through setting up the Patient Intake/Output Recorder
+(PIOR) project. Follow the steps below to install dependencies, configure
+settings, and start the server.
 
-    ```json
-    {
-        "token": "{your_token_here}"
-    }
-    ```
+### Installation
+
+#### Install Dependencies
+
+Patient Intake Output Recorder can be set up with either Poetry (recommended) or
+pip. Open a terminal in the project directory and install the dependencies:
 
-2. Run your server: Open your terminal and execute the following commands:
+=== "Using Poetry"
 
-    ```bash
+    ```sh
     poetry install
+    ```
+
+=== "Using pip"
+
+    ```sh
+    pip install -r requirements.txt
+    ```
+
+!!! Note
+
+    Poetry is recommended as it simplifies version management and ensures
+    reproducible builds.
+
+### Configuration
+
+#### Backend
+
+1. In the `backend` directory, create a new `config.json` file.
+2. Replace `{your_token_here}` and `{your_api_url_here}` with your actual token
+   and API URL.
+
+**Example content:**
+
+```json title="backend/config.json"
+{
+  "token": "{your_token_here}",
+  "api_url": "{your_api_url_here}"
+}
+```
+
+#### Frontend (Patient)
+
+1. In the `patient` directory, create a new `config.json` file.
+2. Replace `{your_api_url_here}` with your actual API URL.
+
+**Example content:**
+
+```json title="patient/config.json"
+{
+  "apiUrl": "{your_api_url_here}"
+}
+```
+
+#### Frontend (Monitor)
+
+1. In the `monitor` directory, create a new `config.json` file.
+2. Replace `{your_api_url_here}` and `{your_web_url_here}` with your actual API
+   URL and web URL.
+
+**Example content:**
+
+```json title="monitor/config.json"
+{
+  "apiUrl": "{your_api_url_here}",
+  "webUrl": "{your_web_url_here}"
+}
+```
+
+### Running the server
+
+Once installed and configured, you can start the server with Uvicorn.
+
+=== "Using Poetry"
+
+    ```sh
+    poetry run uvicorn main:app --reload
+    ```
+
+=== "Using Python"
+
+    ```sh
     python -m uvicorn main:app --reload
     ```
 
-    This will install the necessary dependencies using Poetry and start your server using Uvicorn with automatic reloading enabled.
-    With these steps completed, your server should be up and running, ready to handle requests.
+This command launches the server with hot-reloading enabled, which automatically
+restarts the server upon code changes. With these steps completed, your server
+should be up and running, ready to handle requests.
 
 ## Want to Contribute?
 
-Refer to [CONTRIBUTING.md](./CONTRIBUTING.md)
+Refer to
+[CONTRIBUTING.md](https://github.com/LifeAdventurer/patient-intake-output-recorder/blob/main/CONTRIBUTING.md)
 
-## LICENSE
+## License
 
-See [LICENSE](./LICENSE) for more information.
+This project is licensed under the GNU General Public License v3.0 (GPL-3.0).
+See the
+[LICENSE](https://github.com/LifeAdventurer/patient-intake-output-recorder/blob/main/LICENSE)
+for more information.