Chem Data Handler

Chem Data Handler is a React Vite project designed to handle and visualize chemical data efficiently.

Introduction

Chem Data Handler is a React-based application that leverages Vite for fast development and building. This project aims to provide tools for managing and visualizing chemical data in a user-friendly interface.

Installation

To get started with Chem Data Handler, follow these steps:

1. Clone the repository:

   git clone https://github.com/dominicpam89/chem-data-handler.git
   cd chem-data-handler

2. Install dependencies:

   Make sure you have Node.js installed, then run:

   npm install

3. Run the development server:

   npm run dev

4. Build the project:

   npm run build

5. Preview the production build:

   npm run serve

Usage

After installing and running the development server, you can access the application in your web browser at http://localhost:5173.

Established Features

• Existing Compounds: View compounds in MUI X Grid format
• Pubchem Access: Retrieve and view data from pubchem's database
• Ketcher: Interactive 3rd party app to visualize and create chemical data using Ketcher.

Project Structure

A brief overview of the project structure:

chem-data-handler/
├── public/             # Static files
├── src/                # Source files
│   ├── assets/         # Assets (images, styles, etc.)
│   ├── components/     # React components
│   ├── pages/          # Pages
│   ├── services/       # API calls and data handling
│   ├── App.jsx         # Main App component
│   └── main.jsx        # Entry point
├── .gitignore          # Git ignore file
├── package.json        # NPM package configuration
├── README.md           # Project documentation
└── vite.config.js      # Vite configuration

Contributing

We welcome contributions! To contribute, follow these steps:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Make your changes and commit them:

   git commit -m "Add your message here"

4. Push to the branch:

   git push origin feature/your-feature-name

5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.