Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cybermaxi7/gynescope
https://github.com/cybermaxi7/gynescope
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/cybermaxi7/gynescope
- Owner: Cybermaxi7
- Created: 2024-10-14T09:02:26.000Z (2 months ago)
- Default Branch: cybermaxi
- Last Pushed: 2024-10-19T00:57:36.000Z (2 months ago)
- Last Synced: 2024-10-19T13:26:25.540Z (2 months ago)
- Language: TypeScript
- Homepage: https://gynescope.vercel.app
- Size: 2.88 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gynescope
## Overview
**Gynescope** is a web application built using **Next.js** that focuses on facilitating laboratory tests and interactions between doctors and patients. It allows doctors to manage patient lab tests, view results, and streamline communication within a medical environment. This project was developed during the frontend training program organized by **Leadway Assurance**.
## Table of Contents
- [Project Description](#project-description)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Contributing](#contributing)
- [License](#license)
## Project Description
The goal of **Gynescope** is to build a robust platform that supports doctors in managing their patients' laboratory tests and results. It provides a dashboard for doctors to view and handle patient data and a seamless interface for patients to access their test results.
The project was undertaken as part of the frontend training curriculum by **Leadway Assurance** to improve my understanding of **React**, **Next.js**, and **modern frontend development practices**.
### Project Status
⚠️ **Note**: This project is still in development and is not yet fully functional. Contributions are welcome to help complete the functionality and improve the overall platform.
## Features
- **Dashboard**: Manage patients, view test results, and access lab data.
- **Authentication**: Secure login system for doctors and patients.
- **Responsive Design**: Optimized for desktop and mobile devices.
- **Laboratory Test Management**: Track and manage laboratory test records efficiently.
## Technologies Used
This project uses a range of modern technologies to build a fast and responsive web application:
- **Next.js** - React framework for server-side rendering and static site generation.
- **React** - Frontend library for building UI components.
- **Tailwind CSS** - Utility-first CSS framework for styling the application.
- **TypeScript (ES6+)** - Core language for building the application logic.
- **Node.js** - For backend integration and server-side operations.
- **Supabase** - User authentication system.
## Installation
To run this project locally, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/cybermaxi7/gynescope.git
```
2. Navigate to the project directory:
```bash
cd gynescope
```
3. Install the dependencies:
```bash
yarn
```
4. Run the development server:
```bash
yarn dev
```
5. Open [http://localhost:3000](http://localhost:3000) in your browser to view the app.
## Contributing
As the project is still under development, contributions are highly encouraged to help complete it.
To contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature-name`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature/your-feature-name`).
6. Open a pull request.
## License
This project is licensed under the **MIT License**.