Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 47 additions & 34 deletions frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,51 +62,60 @@ A modern, responsive Progressive Web Application (PWA) for emergency medical res
- **Package Manager**: npm
- **Code Quality**: ESLint, TypeScript

## Getting Started
## Build Instructions

### Prerequisites

- Node.js (v16 or higher)
- npm (v7 or higher)
- npm (v8 or higher)

### Installation
```bash
# Install dependencies
npm install
```

1. Clone the repository:
```bash
git clone https://github.com/yourusername/MediSync.git
cd MediSync/frontend
```
### Development
```bash
# Start development server
npm run dev
```

2. Install dependencies:
```bash
npm install
```
### Production Build
```bash
# Create production build
npm run build

3. Start the development server:
```bash
npm run dev
```
# The build artifacts will be stored in the `dist/` directory
```

4. Build for production:
```bash
npm run build
```
### Preview Production Build
```bash
# Preview the production build locally
npm run preview
```

### Development
### Additional Scripts
```bash
# Run linting
npm run lint

# Generate icons
npm run generate-icons
```

The project follows a modular architecture with the following structure:
## Project Structure

```
frontend/
├── src/
│ ├── components/ # Reusable UI components
│ ├── pages/ # Main application pages
│ ├── routes/ # Routing configuration
│ ├── styles/ # Global styles and themes
│ ├── assets/ # Static assets
│ ├── components/ # Reusable components
│ ├── pages/ # Page components
│ ├── contexts/ # React contexts
│ ├── hooks/ # Custom hooks
│ ├── theme/ # Theme configuration
│ └── utils/ # Utility functions
├── public/ # Public assets
└── vite.config.ts # Vite configuration
├── public/ # Static assets
└── dist/ # Build output (generated)
```

## Progressive Web App Features
Expand Down Expand Up @@ -157,11 +166,9 @@ frontend/

## Contributing

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
1. Create a feature branch
2. Make your changes
3. Submit a pull request

## License

Expand All @@ -170,3 +177,9 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
## Contact

Project Link: [https://github.com/yourusername/MediSync](https://github.com/yourusername/MediSync)

## Environment Variables
Create a `.env` file in the root directory with the following variables:
```env
VITE_API_URL=your_api_url
```
17 changes: 15 additions & 2 deletions frontend/index.html
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
<!doctype html>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite + React + TS</title>
<title>MediSync - Medical Emergency Response System</title>
<link
href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&display=swap"
rel="stylesheet"
/>
<style>
html, body, #root {
height: 100%;
width: 100%;
margin: 0;
padding: 0;
overflow: hidden;
}
</style>
</head>
<body>
<div id="root"></div>
Expand Down
Loading