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

https://github.com/cx-luo/elabx

An AI driven electronic laboratory notebook (ELN), It is designed to help researchers, chemists, and engineers record and organize experimental data efficiently.
https://github.com/cx-luo/elabx

ai-labs aidd drug-discovery eln gin golang python3 vue3

Last synced: 4 days ago
JSON representation

An AI driven electronic laboratory notebook (ELN), It is designed to help researchers, chemists, and engineers record and organize experimental data efficiently.

Awesome Lists containing this project

README

          

eLabX


An AI-driven Electronic Laboratory Notebook (ELN)

---

## 🌟 Introduction

**eLabX** is an open-source, AI-driven electronic laboratory notebook (ELN) system built with:

- πŸ’» Frontend: [Vben-Admin](https://github.com/vbenjs/vue-vben-admin) + [Element Plus](https://element-plus.org/)
- πŸ”§ Backend: [Gin](https://gin-gonic.com/) + [GORM](https://gorm.io/)
- 🧠 AI Support: Integration-ready with OpenAI for auto-lab-note summarization, analysis, etc.

It is designed to help researchers, chemists, and engineers record and organize experimental data efficiently.

---

## πŸ–ΌοΈ Screenshots

Here are some highlights of eLabX in action:

| | |
|---|---|
| **ζ¦‚θ§ˆ Overview**
![Overview](docs/img/elabx-overview.jpg) | **ζ–°ε’žθ―•ε‰‚ Add New Reagent**
![Add New Reagent](docs/img/elabx-add-new-reagent.png) |
| **ι€†εˆζˆ Retrosynthesis**
![Retrosynthesis](docs/img/retrosynthesis.jpg) | **村仢推荐 Condition Recommendation**
![Condition Recommendation](docs/img/condition-recommendation.jpg) |
| **δΊ§ε“δΏ‘ζ―δΈŽζ ·ε“ Product Info & Sample**
![Product Info & Samples](docs/img/product-info-and-samples.png) | **Embed Marvin JS**
![Embed Marvin JS](docs/img/embed-marvin-js.jpg) |

---

## πŸš€ Features

- πŸ“ Manage experiments, protocols, and samples
- 🧠 AI-assisted text summarization and suggestions
- πŸ” User authentication and role-based access control
- πŸ“Š Data table with dynamic sorting/filtering (vben-admin)
- πŸ“‚ Export/Import records
- 🌐 RESTful API backend with Gin
- πŸ“¦ Modular frontend using Vue 3 + Vite

---

## πŸ“¦ Tech Stack

| Layer | Tech |
|-----------|---------------------------------|
| Frontend | Vue 3, Vben-Admin, Element Plus |
| Backend | Gin, GORM, MySQL/Postgres |
| AI (opt) | OpenAI API or custom LLMs |
| Auth | JWT |

---

## πŸ“„ Installation

### Backend

```bash
cd server
go mod tidy
go run main.go
````

### Frontend

```bash
cd web
pnpm install
pnpm dev
```

Configure environment variables in `.env` and `config.yaml`.

---

## πŸ› οΈ Project Structure

```bash
eLabX/
β”œβ”€β”€ web/ # Frontend (Vue + Vben-Admin)
β”œβ”€β”€ server/ # Backend (Gin + GORM)
β”œβ”€β”€ docs/ # Optional docs
β”œβ”€β”€ README.md
└── LICENSE
```

---

## πŸ“Œ Roadmap

* [x] CRUD for lab notes
* [x] AI summarization
* [ ] Multi-user collaboration
* [ ] Full audit trail
* [ ] Mobile support

---

## 🀝 Contributing

Contributions are welcome! Please fork the repo and submit a pull request.

1. 🍴 Fork it
2. 🧩 Create your feature branch (`git checkout -b feature/thing`)
3. πŸ§ͺ Commit changes (`git commit -am 'Add feature'`)
4. πŸ“¬ Push and submit PR

---

## πŸ“œ License

This project is licensed under the **MIT License**.

> You can find it in the [`LICENSE`](./LICENSE) file.
> If you're using third-party libraries (like OpenAI SDK), check and **respect their licenses too.**

---

## πŸ“¬ Contact

Created by chengxiang.luo – feel free to reach out!

Email: `chengxiang.luo@foxmail.com`
GitHub: [@cx-luo](https://github.com/cx-luo)

---

## 🌐 Languages

* πŸ‡¨πŸ‡³ δΈ­ζ–‡ζ–‡ζ‘£οΌš[README.zh.md](docs/README.zh.md)
* 🌍 English (this file)