Skip to content

matylerb/Mindfulness_App

Repository files navigation

Mindfulness App

This is a minimal and peaceful React project for a mindfulness app. It is designed to provide a calming user experience.

Prerequisites

  • Node.js and npm installed (for the frontend) -> https://nodejs.org/en/download
  • Python installed (for the backend) (version 3.13.1 is the one i'm using)

Setup Instructions

Frontend

  1. Install the frontend dependencies:
    npm install
  2. Start the development server:
    npm run dev
  3. Open your browser to the provided local development URL.

Backend

  1. Install the backend dependencies:
    pip install -r requirements.txt
  2. Start the backend server:
    python main.py

Running the App

  1. Ensure both the frontend and backend servers are running.
  2. Access the app in your browser at the URL provided by the frontend development server.

Notes

  • The backend requires a .env file which is provided you just need to enter your own GROQ API key which can be found at https://console.groq.com/keys

    GROQ_API_KEY=your_api_key_here
    

    Replace your_api_key_here with your actual API key.

  • If you encounter any issues, ensure all dependencies are installed and the servers are running on the correct ports.

  • November 2025, What I would do now, containerize it using Docker!

About

This is an app I created for my Sustainable Data Science And AI module in University

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors