Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Vidit-Kushwaha authored Apr 3, 2024
1 parent 9ff66c6 commit a9ebbb6
Showing 1 changed file with 28 additions and 9 deletions.
37 changes: 28 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,45 @@
# 3D-Chemistry

![image](https://github.com/Vidit-Kushwaha/3D-Chemistry/blob/main/assets/image.png)

Demo : https://threed-chemistry.onrender.com

# Technologies Used

## Table of Contents

- [Technologies Used](#technologies-used)
- [Features](#features)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [License](#license)

## Technologies Used

- JavaScript
- 3DMol.js
- jQuery
- Ajax


# Key Functionalities:
## Features

- Styles for Rendering (i.e. stick, sphere, line, and cross)
- Measuring Distances
- Atom Labeling
- **Upload CJSON, PDB Files:** Users can upload CJSON, PDB files containing structures.
- **Suported Model:** Supporded different model format (pdb, cif, cid,smiles, mmtf).
- **Styles:** Models feature a variety of styles, such as spherical, ball, stick, cross, and cartoon.
- **Annotate the element:** Users can annotate specific elements in a structure by hovering over them.
- **Measure Distance:** Clicking over two atoms allows the user to measure their distance.
- **Visualise in 3D:** The 3D molecular structure was rendered using the 3Dmol.js framework.

# Getting Started:
## Getting Started:

- Clone this repository: `git clone https://github.com/Vidit-Kushwaha/3D-Chemistry.git`
- Clone this repository:
```bash
git clone https://github.com/Vidit-Kushwaha/3D-Chemistry.git`
- Start the development server.
# Contributing
## Contributing
We welcome contributions! Whether you're a seasoned developer or a curious enthusiast.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/Vidit-Kushwaha/3D-Chemistry/blob/main/LICENSE) file for details.

0 comments on commit a9ebbb6

Please sign in to comment.