itsLu commited on
Commit
e66776d
·
verified ·
1 Parent(s): 2586888

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -97
README.md CHANGED
@@ -1,97 +1,12 @@
1
- # Welcome to your Lovable project
2
-
3
- ## Project info
4
-
5
- **URL**: https://lovable.dev/projects/REPLACE_WITH_PROJECT_ID
6
-
7
- ## How can I edit this code?
8
-
9
- There are several ways of editing your application.
10
-
11
- **Use Lovable**
12
-
13
- Simply visit the [Lovable Project](https://lovable.dev/projects/REPLACE_WITH_PROJECT_ID) and start prompting.
14
-
15
- Changes made via Lovable will be committed automatically to this repo.
16
-
17
- **Use your preferred IDE**
18
-
19
- If you want to work locally using your own IDE, you can clone this repo and push changes. Pushed changes will also be reflected in Lovable.
20
-
21
- The only requirement is having Node.js & npm installed - [install with nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
22
-
23
- Follow these steps:
24
-
25
- ```sh
26
- # Step 1: Clone the repository using the project's Git URL.
27
- git clone <YOUR_GIT_URL>
28
-
29
- # Step 2: Navigate to the project directory.
30
- cd <YOUR_PROJECT_NAME>
31
-
32
- # Step 3: Install the necessary dependencies.
33
- npm i
34
-
35
- # Step 4: Start the development server with auto-reloading and an instant preview.
36
- npm run dev
37
- ```
38
-
39
- **Edit a file directly in GitHub**
40
-
41
- - Navigate to the desired file(s).
42
- - Click the "Edit" button (pencil icon) at the top right of the file view.
43
- - Make your changes and commit the changes.
44
-
45
- **Use GitHub Codespaces**
46
-
47
- - Navigate to the main page of your repository.
48
- - Click on the "Code" button (green button) near the top right.
49
- - Select the "Codespaces" tab.
50
- - Click on "New codespace" to launch a new Codespace environment.
51
- - Edit files directly within the Codespace and commit and push your changes once you're done.
52
-
53
- ## What technologies are used for this project?
54
-
55
- This project is built with:
56
-
57
- - Vite
58
- - TypeScript
59
- - React
60
- - shadcn-ui
61
- - Tailwind CSS
62
-
63
- ## How can I deploy this project?
64
-
65
- Simply open [Lovable](https://lovable.dev/projects/REPLACE_WITH_PROJECT_ID) and click on Share -> Publish.
66
-
67
- ## Can I connect a custom domain to my Lovable project?
68
-
69
- Yes, you can!
70
-
71
- To connect a domain, navigate to Project > Settings > Domains and click Connect Domain.
72
-
73
- Read more here: [Setting up a custom domain](https://docs.lovable.dev/features/custom-domain#custom-domain)
74
-
75
- ## Deployment (Hugging Face Spaces)
76
-
77
- This project is set up as a **Docker Space**:
78
- - Frontend: Vite/React (built to `/app/static`)
79
- - Backend: FastAPI (`/api/analyze`) that runs your Keras model on video frames and returns EF + heart function.
80
-
81
- ### Required files
82
- Place your trained Keras model in the repo root as:
83
-
84
- - `model.keras` (or set `MODEL_PATH` env var in the Space)
85
-
86
- The scaler is already referenced as:
87
- - `scaler.save` (loaded from `/app/scaler.save`)
88
-
89
- ### Run locally
90
- ```bash
91
- npm install
92
- npm run build
93
- python -m venv .venv && source .venv/bin/activate
94
- pip install -r requirements.txt
95
- MODEL_PATH=./model.keras uvicorn backend.main:app --reload --port 7860
96
- ```
97
- Then open http://localhost:7860
 
1
+ ---
2
+ title: Cardexa
3
+ emoji: ❤️
4
+ colorFrom: indigo
5
+ colorTo: pink
6
+ sdk: docker
7
+ pinned: false
8
+ ---
9
+ # Cardexa
10
+
11
+ AI-powered cardiac analysis from echocardiography videos.
12
+ Upload a heart scan video to estimate EDV, ESV, and Ejection Fraction.