Add Quick Start section to README
This commit is contained in:
parent
d9c91f42be
commit
2177e79566
1 changed files with 19 additions and 0 deletions
19
README.md
19
README.md
|
|
@ -6,6 +6,25 @@ A powerful 3D model file manager for makers and 3D printing enthusiasts. Organiz
|
||||||
|
|
||||||
*Browse, organize, and view your 3D models in an intuitive interface*
|
*Browse, organize, and view your 3D models in an intuitive interface*
|
||||||
|
|
||||||
|
## ⚡ Quick Start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Clone the repository
|
||||||
|
git clone https://github.com/dlawler489/makerstash.git
|
||||||
|
cd makerstash
|
||||||
|
|
||||||
|
# Install dependencies
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# Setup environment
|
||||||
|
cp .env.example .env
|
||||||
|
|
||||||
|
# Run the application
|
||||||
|
npm start
|
||||||
|
```
|
||||||
|
|
||||||
|
Visit **http://localhost:3000** and register a new account!
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Interactive 3D Viewer** - View and rotate STL, OBJ, and 3MF models directly in the browser with Three.js
|
- **Interactive 3D Viewer** - View and rotate STL, OBJ, and 3MF models directly in the browser with Three.js
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue