181 lines
4.4 KiB
Markdown
181 lines
4.4 KiB
Markdown
# TFGrid Get Started
|
|
|
|
Your gateway to ThreeFold - learn how to farm, connect, and deploy on the decentralized internet.
|
|
|
|
**Live Site**: https://threefold.info/getstarted
|
|
|
|
## Overview
|
|
|
|
This repository contains the getting started documentation for ThreeFold, designed to help newcomers:
|
|
|
|
1. **Become a Farmer** - Deploy nodes and earn rewards
|
|
2. **Use Mycelium Network** - Connect devices securely with IPv6 overlay networking
|
|
3. **Deploy on Mycelium Cloud** - Run Kubernetes clusters on the ThreeFold Grid
|
|
|
|
## Quick Start
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js 18+
|
|
- pnpm (or npm)
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
# Clone the repository
|
|
git clone https://git.ourworld.tf/tfgrid/docs_tfgrid_get_started
|
|
cd docs_tfgrid_get_started
|
|
|
|
# Install dependencies
|
|
pnpm install
|
|
|
|
# Start development server
|
|
pnpm start
|
|
```
|
|
|
|
The site will open at `http://localhost:3000`.
|
|
|
|
### Build
|
|
|
|
```bash
|
|
# Create production build
|
|
pnpm run build
|
|
|
|
# Serve production build locally
|
|
pnpm run serve
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
docs_tfgrid_get_started/
|
|
├── docs/ # Documentation content
|
|
│ ├── intro.md # Homepage/Introduction
|
|
│ ├── farming/ # Farming guides
|
|
│ │ ├── overview.md
|
|
│ │ ├── buy-node.md
|
|
│ │ └── setup.md
|
|
│ ├── mycelium-network/ # Mycelium Network guides
|
|
│ │ ├── overview.md
|
|
│ │ ├── install.md
|
|
│ │ └── quick-start.md
|
|
│ └── mycelium-cloud/ # Mycelium Cloud guides
|
|
│ ├── overview.md
|
|
│ ├── getting-started.md
|
|
│ └── tutorial.md
|
|
├── static/ # Static assets
|
|
│ ├── img/ # Images and logos
|
|
│ ├── CNAME # Custom domain config
|
|
│ └── _redirects # Redirect rules
|
|
├── src/ # Custom components & styles
|
|
│ └── css/
|
|
│ └── custom.css # Custom styling
|
|
├── docusaurus.config.js # Docusaurus configuration
|
|
├── sidebars.js # Sidebar structure
|
|
├── package.json # Dependencies
|
|
├── build.sh # Production build script
|
|
└── develop.sh # Development script
|
|
```
|
|
|
|
## Contributing
|
|
|
|
### Making Changes
|
|
|
|
1. Pull latest changes:
|
|
```bash
|
|
git pull origin main
|
|
```
|
|
|
|
2. Make your edits in `docs/`
|
|
|
|
3. Test locally:
|
|
```bash
|
|
pnpm start
|
|
```
|
|
|
|
4. Test production build:
|
|
```bash
|
|
pnpm run build
|
|
```
|
|
|
|
5. Commit and push:
|
|
```bash
|
|
git add .
|
|
git commit -m "Description of changes"
|
|
git push origin main
|
|
```
|
|
|
|
### Content Guidelines
|
|
|
|
- **Keep it simple** - Target audience is new to ThreeFold
|
|
- **Be concise** - No fluff, straight to the point
|
|
- **Use examples** - Practical code snippets and commands
|
|
- **Clear structure** - Logical flow from overview to hands-on
|
|
- **Test builds** - Always verify builds succeed before pushing
|
|
|
|
## Documentation Sections
|
|
|
|
### Farming
|
|
|
|
Guides for becoming a ThreeFold farmer:
|
|
- What is farming and why do it
|
|
- How to buy or build a node
|
|
- Setting up and connecting to the grid
|
|
|
|
### Mycelium Network
|
|
|
|
Guides for using Mycelium networking:
|
|
- What is Mycelium and its benefits
|
|
- Installation across platforms
|
|
- Quick start and connectivity
|
|
|
|
### Mycelium Cloud
|
|
|
|
Guides for deploying on the grid:
|
|
- What is Mycelium Cloud
|
|
- Getting started with clusters
|
|
- Deployment tutorials and examples
|
|
|
|
## Development
|
|
|
|
### Local Development
|
|
|
|
```bash
|
|
# Start development server
|
|
./develop.sh
|
|
# OR
|
|
pnpm start
|
|
```
|
|
|
|
This command starts a local development server and opens a browser window. Most changes are reflected live without restarting the server.
|
|
|
|
### Build & Deploy
|
|
|
|
```bash
|
|
# Build for production
|
|
./build.sh
|
|
# OR
|
|
pnpm run build
|
|
```
|
|
|
|
The build script also handles deployment to the production server.
|
|
|
|
## Technology Stack
|
|
|
|
- [Docusaurus 3](https://docusaurus.io/) - Documentation framework
|
|
- [React 18](https://react.dev/) - UI library
|
|
- [MDX](https://mdxjs.com/) - Markdown with JSX support
|
|
|
|
## Links
|
|
|
|
- **Live Site**: [threefold.info/getstarted](https://threefold.info/getstarted)
|
|
- **Main Site**: [threefold.io](https://threefold.io)
|
|
- **Dashboard**: [dashboard.grid.tf](https://dashboard.grid.tf)
|
|
- **Manual**: [manual.grid.tf](https://manual.grid.tf)
|
|
- **Community**: [t.me/threefoldfarmers](https://t.me/threefoldfarmers)
|
|
- **Forum**: [forum.threefold.io](https://forum.threefold.io)
|
|
|
|
## License
|
|
|
|
Copyright © 2025 ThreeFold
|