Changeset 9af201e for frontend/README.md


Ignore:
Timestamp:
09/04/26 19:08:08 (2 weeks ago)
Author:
MBK <marija.karapandzova@…>
Branches:
master
Children:
cdcff72
Parents:
e1f74f6
Message:

Fix frontend appearance

File:
1 edited

Legend:

Unmodified
Added
Removed

  • frontend/README.md

    re1f74f6 r9af201e  
    1 # Getting Started with Create React App
     1# Medora Frontend
    22
    3 This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
     3A modern React-based frontend for the Medora Medical Records Management System.
    44
    5 ## Available Scripts
     5## Features
    66
    7 In the project directory, you can run:
     7- **Patient Management**: Create, view, and manage patient information
     8- **Doctor Management**: Manage doctor profiles and specializations
     9- **Appointments**: Schedule and manage medical appointments
     10- **Medical Records**: Access and search patient medical records
     11- **Billing**: Manage billing records and payment status
     12- **Responsive Design**: Works seamlessly on desktop and mobile devices
    813
    9 ### `npm start`
     14## Prerequisites
    1015
    11 Runs the app in the development mode.\
    12 Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
     16- Node.js (v14 or higher)
     17- npm or yarn
    1318
    14 The page will reload when you make changes.\
    15 You may also see any lint errors in the console.
     19## Installation
    1620
    17 ### `npm test`
     211. Navigate to the frontend directory:
     22```bash
     23cd frontend
     24```
    1825
    19 Launches the test runner in the interactive watch mode.\
    20 See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
     262. Install dependencies:
     27```bash
     28npm install
     29```
    2130
    22 ### `npm run build`
     313. Create a `.env` file in the frontend directory:
     32```
     33REACT_APP_API_URL=http://localhost:8080/api
     34```
    2335
    24 Builds the app for production to the `build` folder.\
    25 It correctly bundles React in production mode and optimizes the build for the best performance.
     36## Running the Application
    2637
    27 The build is minified and the filenames include the hashes.\
    28 Your app is ready to be deployed!
     38Start the development server:
     39```bash
     40npm start
     41```
    2942
    30 See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
     43The application will open at `http://localhost:3000`
    3144
    32 ### `npm run eject`
     45## Building for Production
    3346
    34 **Note: this is a one-way operation. Once you `eject`, you can't go back!**
     47```bash
     48npm run build
     49```
    3550
    36 If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
     51This creates a production-ready build in the `build` directory.
    3752
    38 Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
     53## Project Structure
    3954
    40 You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
     55```
     56frontend/
     57├── public/               # Static assets
     58├── src/
     59│   ├── components/      # Reusable React components
     60│   ├── pages/           # Page components
     61│   │   ├── patients/
     62│   │   ├── doctors/
     63│   │   ├── appointments/
     64│   │   ├── medical-records/
     65│   │   └── billing/
     66│   ├── services/        # API service modules
     67│   ├── App.js          # Main app component
     68│   ├── index.js        # React entry point
     69│   └── index.css       # Global styles
     70├── package.json
     71└── tailwind.config.js  # Tailwind CSS configuration
     72```
    4173
    42 ## Learn More
     74## API Endpoints
    4375
    44 You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
     76The frontend communicates with the backend API at:
     77- Base URL: `http://localhost:8080/api`
    4578
    46 To learn React, check out the [React documentation](https://reactjs.org/).
     79Ensure the backend server is running before starting the frontend.
    4780
    48 ### Code Splitting
     81## Technologies Used
    4982
    50 This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
     83- **React 18**: UI library
     84- **React Router 6**: Client-side routing
     85- **Axios**: HTTP client
     86- **Tailwind CSS**: Utility-first CSS framework
    5187
    52 ### Analyzing the Bundle Size
     88## License
    5389
    54 This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
    55 
    56 ### Making a Progressive Web App
    57 
    58 This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
    59 
    60 ### Advanced Configuration
    61 
    62 This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
    63 
    64 ### Deployment
    65 
    66 This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
    67 
    68 ### `npm run build` fails to minify
    69 
    70 This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
     90This project is part of the Medora Medical Records Management System.
Note: See TracChangeset for help on using the changeset viewer.