Skip to content

3D model viewer based on electron, react, three & material-ui

License

Notifications You must be signed in to change notification settings

dartignan/lithium

Repository files navigation

Build/release lithium

Lithium

Lithium is a 3D model viewer based on electron, react, three.js, react-three-fiber & material-ui.

Lithium screenshot

The name of this project comes from the 3 main packages this project relies on: electron, three.js and material-ui. The lithium metal is a three-electron-material (in its neutral form).

Features

Supported formats

Lithium currently supports the following file formats:

3D View

The 3D view supports camera gestures, as well as item selection.

Clipping

The slider on the right enables to clip the parts with an horizontal plane.

Download

Download the latest release for Windows, Mac & Linux from the releases page.

For Linux, the app can also be installed from Snapcraft.

Development

To clone and run this repository you'll need Git, Node.js and yarn installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/dartignan/lithium
# Go into the repository
cd lithium
# Install dependencies
yarn install
# Run the app
yarn start

This project was bootstrapped with Create React App.

Debugging

This project contains the following debug configurations for VSCode:

Configuration | Description

  • | - Electron: Main | Runs the app and attachs to the main (node) process. Electron: Renderer | Attachs to the renderer (chrome) process. Electron: All | Runs the app and attachs to both main and renderer processes.

Packaging & CI

Electron Builder is used to generate installation packages for Windows, MacOS and Linux.

GitHub Actions are set up using Action Electron Builder.

Acknowledgements

Thanks to all the contributors of the packages used in this project, and the help provided on GitHub, Medium and StackOverflow.