0d073fa89e
- Add GETTING_STARTED.md with quick start guide and development modes - Add INSTALL.sh automated installation script - Add INSTALLATION_CHECKLIST.md, INSTALLATION_SUCCESS.md, and INSTALLATION_SUMMARY.md - Add QUICK_REFERENCE.md for common commands - Add SETUP_GUIDE.md with detailed setup instructions - Update README.md with improved project overview - Add did-wallet app dependencies and node_modules
161 lines
3.3 KiB
Markdown
161 lines
3.3 KiB
Markdown
# Installation Complete! 🎉
|
|
|
|
The installation was **successful**! Here's what was installed:
|
|
|
|
## ✅ Installed Components
|
|
|
|
### System Tools
|
|
- **Homebrew** - macOS package manager
|
|
- **Rust 1.93.0** - Backend programming language
|
|
- **Cargo** - Rust package manager
|
|
- **Node.js v24.13.0** - JavaScript runtime
|
|
- **npm** - Node package manager
|
|
- **Podman 5.7.1** - Container runtime (running)
|
|
- **PostgreSQL 15** - Database (service started)
|
|
|
|
### Project Dependencies
|
|
|
|
#### Frontend (neode-ui)
|
|
- ✅ 554 packages installed
|
|
- ✅ No vulnerabilities
|
|
- Ready to run
|
|
|
|
#### Custom Apps
|
|
- ✅ **did-wallet** - 238 packages
|
|
- ✅ **endurain** - 100 packages
|
|
- ✅ **morphos-server** - 100 packages
|
|
- ✅ **router** - 126 packages
|
|
- ✅ **web5-dwn** - 238 packages
|
|
|
|
All custom app dependencies installed!
|
|
|
|
## 🔧 Final Step Required
|
|
|
|
The Rust backend needs to be built. Run this in your terminal:
|
|
|
|
```bash
|
|
cd /Users/dorian/Projects/archy
|
|
./complete-setup.sh
|
|
```
|
|
|
|
This will:
|
|
1. Verify Rust installation
|
|
2. Build the backend (takes a few minutes)
|
|
3. Show you next steps
|
|
|
|
## 🚀 How to Start the Project
|
|
|
|
### Option 1: Full Stack (After building backend)
|
|
|
|
**Terminal 1 - Backend:**
|
|
```bash
|
|
cd /Users/dorian/Projects/archy/core
|
|
cargo run --bin archipelago
|
|
```
|
|
|
|
**Terminal 2 - Frontend:**
|
|
```bash
|
|
cd /Users/dorian/Projects/archy/neode-ui
|
|
npm run dev
|
|
```
|
|
|
|
**Open:** http://localhost:8100
|
|
|
|
### Option 2: Mock Backend (Works Now!)
|
|
|
|
You can start the frontend with a mock backend immediately:
|
|
|
|
```bash
|
|
cd /Users/dorian/Projects/archy/neode-ui
|
|
npm run dev:mock
|
|
```
|
|
|
|
**Open:** http://localhost:8100
|
|
|
|
### Option 3: Interactive Script
|
|
|
|
```bash
|
|
cd /Users/dorian/Projects/archy
|
|
./scripts/dev-start.sh
|
|
```
|
|
|
|
Choose option 1 for mock backend (fastest).
|
|
|
|
## 📋 What's Running
|
|
|
|
- **PostgreSQL** - Running on port 5432 (auto-starts on boot)
|
|
- **Podman Machine** - Running (for containers)
|
|
|
|
## 🔍 Verify Installation
|
|
|
|
Run this to check everything:
|
|
|
|
```bash
|
|
cd /Users/dorian/Projects/archy
|
|
./verify-install.sh
|
|
```
|
|
|
|
## 📚 Documentation
|
|
|
|
- **GETTING_STARTED.md** - Quick start guide
|
|
- **SETUP_GUIDE.md** - Detailed setup
|
|
- **QUICK_REFERENCE.md** - Command reference
|
|
- **README.md** - Project overview
|
|
|
|
## ⚡ Quick Commands
|
|
|
|
```bash
|
|
# Complete setup (build backend)
|
|
./complete-setup.sh
|
|
|
|
# Start with mock backend (fastest)
|
|
cd neode-ui && npm run dev:mock
|
|
|
|
# Check installation status
|
|
./verify-install.sh
|
|
|
|
# Start PostgreSQL
|
|
brew services start postgresql@15
|
|
|
|
# Start Podman machine
|
|
podman machine start
|
|
```
|
|
|
|
## 🎯 Next Steps
|
|
|
|
1. **Build the backend:**
|
|
```bash
|
|
./complete-setup.sh
|
|
```
|
|
|
|
2. **Or try the UI immediately:**
|
|
```bash
|
|
cd neode-ui
|
|
npm run dev:mock
|
|
```
|
|
|
|
3. **Then explore the docs:**
|
|
- Read GETTING_STARTED.md
|
|
- Check out the apps in `/apps`
|
|
- Build containerized apps with `cd apps && ./build.sh`
|
|
|
|
## 💡 Notes
|
|
|
|
- Rust was installed but needs the backend built
|
|
- All Node.js dependencies are ready
|
|
- Some apps have security vulnerabilities (run `npm audit` to see)
|
|
- Podman is configured in rootless mode (more secure)
|
|
- PostgreSQL is running as a background service
|
|
|
|
## 🐛 If Something Goes Wrong
|
|
|
|
1. Run `./verify-install.sh`
|
|
2. Check services:
|
|
- PostgreSQL: `brew services list`
|
|
- Podman: `podman machine list`
|
|
3. Read SETUP_GUIDE.md for troubleshooting
|
|
|
|
---
|
|
|
|
**You're almost ready! Just run `./complete-setup.sh` to build the backend, or start the mock backend right away!** 🚀
|