Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prititi/clinical_fe


https://github.com/prititi/clinical_fe

Last synced: 7 days ago
JSON representation

Awesome Lists containing this project

README

        

# Clinical App for PTSD Treatment

## Overview

This clinical app is a comprehensive and essential tool for clinicians in the healthcare sector, initially focusing on treating patients with PTSD with planned future expansion into other areas of mental health. Its primary purpose is to facilitate the creation, customization, and management of immersive 3D environments used in VR therapy. By providing a streamlined, user-friendly experience, the website equips clinicians with the necessary tools to offer personalized and effective treatment experiences, enhancing their therapeutic practices through cutting-edge virtual reality technology.

## Frontend Features

### Landing Page/Welcome Screen
- **Introduction**: Briefly explains the purpose and benefits of the app.
- **Navigation**: Easy-to-use navigation to help users find their way around the site.
- **Contact Information**: Provides users with ways to reach out for support or inquiries.

### Registration/Login
- **Secure Login**: Ensures user data is protected with secure authentication methods.
- **User Registration**: Allows new users to sign up and create an account.

### Upload Images
- **File Upload**: Users can upload images to be used in the creation of 3D environments for VR therapy.

## Backend Features

### Landing Page/Welcome Screen

### Role base Registration/Login
- **Login Endpoint**: POST `/v1/api/auth/login`.
- **User Registration**: POST `/v1/api/auth/register`.
- **GET User**: GET `/v1/api/auth/users/`.
- **POST User**: POST `/v1/api/users/`.
- **DELETE User**: POST `/v1/api/users/:id`.
- **PUT User**: POST `/v1/api/users/:id`.

### Upload Images
- **File Upload**: POST `/upload`
- **File Upload**: GET `/images`

## Screenshots

### Home Page
![Home Page](src/Image/HomeScreen.png)

### Registration Page
![Registration Page](src/Image/signup.png)

### Login Page
![Login Page](src/Image/login.png)

### Upload Image Page
![Upload Image Page](src/Image/uploadImg.png)

### Contact Page
![Contact Page](src/Image/contact.png)

## Getting Started

### Prerequisites
- [Node.js](https://nodejs.org/) installed on your machine.
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) for package management.

### Installation

1. Clone the repository:
```sh
git clone https://github.com/prititi/Clinical_fe.git
cd clinical-fe
```

2. Install dependencies:
```sh
npm install
```
or
```sh
yarn install
```

3. Start the development server:
```sh
npm run dev
```

### Deployment

For deployment instructions, please refer to the `Deployment` section in the documentation.

1. Backend deployment link:
```sh
https://clinical-3ndq.onrender.com
```

2. Frontend deployment link:
```sh
https://clinical-assignment-qqnp.vercel.app/
```

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

## Contact

For any questions or suggestions, please contact us at [email protected].

---

Thank you for using our clinical app to enhance your therapeutic practices through innovative VR technology. We are committed to helping clinicians provide the best care for their patients.