Skip to content

Latest commit

 

History

History
121 lines (97 loc) · 2.93 KB

README.md

File metadata and controls

121 lines (97 loc) · 2.93 KB
Raw

CampusHER

Introduction

CampusHER is a mobile application designed to provide university women with access to health resources, appointment scheduling, health tips, and more. The backend is developed using Python with Flask (or Django), and the frontend is built using React Native.

Features

  • User Registration and Authentication
  • Personal Health Dashboard
  • Appointment Scheduling with Campus Health Services
  • Health Tips and Articles
  • Chat/Consultation with Health Experts
  • Symptom Checker
  • Notification System for Reminders

Tech Stack

Backend:

  • Python
  • Flask or Django
  • SQLAlchemy (for ORM)

Frontend:

  • React Native

Database:

  • PostgreSQL or MySQL
  • MongoDB (optional)

Setup Instructions

Backend Setup

  1. Clone the repository:

    git clone https://github.com/yourusername/healthapp.git
cd healthapp/backend

  2. Create a virtual environment and activate it:

    python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`

  3. Install the required packages:

    pip install -r requirements.txt

  4. Set up the database:

    from app import db
db.create_all()

  5. Run the backend server:

    flask run

Frontend Setup

  1. Navigate to the frontend directory:

    cd ../frontend

  2. Install the required packages:

    npm install

  3. Start the React Native app:

    npx react-native run-android  # for Android
npx react-native run-ios      # for iOS

Project Structure

healthapp/
|-- backend/
|   |-- app.py
|   |-- models.py
|   |-- routes/
|   |   |-- auth.py
|   |   |-- health.py
|   |-- templates/
|   |-- requirements.txt
|-- frontend/
|   |-- src/
|   |   |-- App.js
|   |   |-- components/
|   |   |-- screens/
|   |-- package.json

API Endpoints

  • POST /register: Register a new user
  • POST /login: Login a user
  • GET /appointments: Get a list of appointments
  • POST /appointments: Schedule a new appointment
  • GET /health-tips: Get health tips and articles
  • POST /chat: Start a chat with a health expert

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for review.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For any queries or further information, please contact:

  • Gayanthika Shankar, Developer

  • Shravanthi Balasubramaniam, Developer

  • Vidhyakshaya Kannan, Developer