Spalla Health - Connecting Patients with Caregivers Spalla Health is a web application designed to connect hospitalized patients and caregivers with local, verified hospital sitters. This project utilizes Flask and Flask-SQLAlchemy to build a scalable backend server, with React for a user-friendly frontend.
Getting Started:
This project uses a Python virtual environment. Ensure you have Python and pip installed. Here's how to set up the development environment:
Clone this repository:
Bash git clone https://github.com/your-username/amazing.git Use code with caution. content_copy Create and activate a virtual environment:
Bash python3 -m venv venv source venv/bin/activate Use code with caution. content_copy Install dependencies:
Bash pip install -r requirements.txt Use code with caution. content_copy Create a .env file in the flask-server directory to store environment variables (database connection string, secret keys, etc.) A template .env.example file is provided.
Configure the database connection:
Bash flask db init flask db migrate -m "Initial Migration" flask db upgrade Use code with caution. content_copy Run the development server:
Bash cd flask-server flask run Use code with caution. content_copy Open http://127.0.0.1:5000/ in your web browser.
Run the React development server:
Bash cd client npm install npm run dev Use code with caution. content_copy A separate browser window or tab should open with the Amazing application frontend.
Project Structure:
flask-server: Contains the Flask backend application code. client: Contains the React frontend application code. Additional Notes:
Authentication and authorization functionalities are currently under development. Error handling and validation are implemented but may require further refinement. This project demonstrates the core functionalities envisioned for Spalla. Further development is planned to include hospital sitter matching and additional features. Additional Resources Code of Conduct: We are committed to fostering a positive and inclusive development environment. Please see the CODE_OF_CONDUCT.md: CODE_OF_CONDUCT.md file for details. Contributing: Please reach out to me directly if you would like to contribute License: This project is licensed under the MIT License: Please reach out directly if you would like to render services Security Policy: We take security seriously. Please see the SECURITY.md: SECURITY.md file for details on how to report security vulnerabilities. Issue Templates: To help streamline the issue reporting process, we've included issue templates. Please use the appropriate template when creating a new issue. Pull Request Template: A pull request template can also be helpful to guide contributors on what information to include in their pull requests.
We appreciate your interest in Spalla Health and have an amazing day!