more configs and readme updates.
This commit is contained in:
parent
c4ea51995e
commit
5f39ce8218
@ -533,13 +533,13 @@ NOCODB_API_URL=https://db.$new_domain/api/v1
|
||||
NOCODB_API_TOKEN=changeme
|
||||
|
||||
# NocoDB View URL is the URL to your NocoDB view where the map data is stored.
|
||||
NOCODB_VIEW_URL=https://db.$new_domain/dashboard/#/nc/your_project_id/your_view_id
|
||||
NOCODB_VIEW_URL=
|
||||
|
||||
# NOCODB_LOGIN_SHEET is the URL to your NocoDB login sheet.
|
||||
NOCODB_LOGIN_SHEET=https://db.$new_domain/dashboard/#/nc/your_project_id/your_login_sheet_id
|
||||
NOCODB_LOGIN_SHEET=
|
||||
|
||||
# NOCODB_SETTINGS_SHEET is the URL to your NocoDB settings sheet.
|
||||
NOCODB_SETTINGS_SHEET=https://db.$new_domain/dashboard/#/nc/your_project_id/your_settings_sheet_id
|
||||
NOCODB_SETTINGS_SHEET=
|
||||
|
||||
# Server Configuration
|
||||
PORT=3000
|
||||
|
||||
168
map/README.md
168
map/README.md
@ -13,9 +13,9 @@ A containerized web application that visualizes geographic data from NocoDB on a
|
||||
- 👤 User authentication with login system
|
||||
- ⚙️ Admin panel for system configuration
|
||||
- 🎯 Configurable map start location
|
||||
- <EFBFBD> Walk Sheet generator for door-to-door canvassing
|
||||
- 📋 Walk Sheet generator for door-to-door canvassing
|
||||
- 🔗 QR code integration for digital resources
|
||||
- <EFBFBD>🐳 Docker containerization for easy deployment
|
||||
- 🐳 Docker containerization for easy deployment
|
||||
- 🆓 100% open source (no proprietary dependencies)
|
||||
|
||||
## Quick Start
|
||||
@ -23,13 +23,94 @@ A containerized web application that visualizes geographic data from NocoDB on a
|
||||
### Prerequisites
|
||||
|
||||
- Docker and Docker Compose
|
||||
- NocoDB instance with a table containing location data
|
||||
- NocoDB instance with API access
|
||||
- NocoDB API token
|
||||
|
||||
### NocoDB Table Setup
|
||||
### Installation
|
||||
|
||||
1. **Main Locations Table** - Create a table with these required columns. The format here is `Column Name - Column Type - Other Settings`:
|
||||
1. **Get NocoDB API Token**
|
||||
|
||||
1. Login to your NocoDB instance
|
||||
2. Click user icon → **Account Settings** → **API Tokens**
|
||||
3. Create new token with read/write permissions
|
||||
4. Copy the token for the next step
|
||||
|
||||
2. **Configure Environment**
|
||||
|
||||
Edit the `.env` file with your NocoDB API and API Url:
|
||||
```env
|
||||
# NocoDB API Configuration
|
||||
NOCODB_API_URL=https://your-nocodb-instance.com/api/v1
|
||||
NOCODB_API_TOKEN=your-api-token-here
|
||||
|
||||
# These will be populated after running build-nocodb.sh
|
||||
NOCODB_VIEW_URL=
|
||||
NOCODB_LOGIN_SHEET=
|
||||
NOCODB_SETTINGS_SHEET=
|
||||
|
||||
# Server Configuration
|
||||
PORT=3000
|
||||
NODE_ENV=production
|
||||
SESSION_SECRET=your-secure-random-string
|
||||
|
||||
# Map Defaults (Edmonton, AB)
|
||||
DEFAULT_LAT=53.5461
|
||||
DEFAULT_LNG=-113.4938
|
||||
DEFAULT_ZOOM=11
|
||||
```
|
||||
|
||||
3. **Auto-Create Database Structure**
|
||||
|
||||
Run the build script to create required tables:
|
||||
```bash
|
||||
chmod +x build-nocodb.sh
|
||||
./build-nocodb.sh
|
||||
```
|
||||
|
||||
This creates three tables:
|
||||
- **Locations** - Main map data with geo-location, contact info, support levels
|
||||
- **Login** - User authentication (email, name, admin flag)
|
||||
- **Settings** - Admin configuration and QR codes
|
||||
|
||||
4. **Get Table URLs**
|
||||
|
||||
After the script completes:
|
||||
1. Login to your NocoDB instance
|
||||
2. Navigate to your project ("Map Viewer Project")
|
||||
3. Copy the view URLs for each table from your browser address bar
|
||||
4. URLs should look like: `https://your-nocodb.com/dashboard/#/nc/project-id/table-id`
|
||||
|
||||
5. **Update Environment with URLs**
|
||||
|
||||
Edit your `.env` file and add the table URLs:
|
||||
```env
|
||||
NOCODB_VIEW_URL=https://your-nocodb.com/dashboard/#/nc/project-id/locations-table-id
|
||||
NOCODB_LOGIN_SHEET=https://your-nocodb.com/dashboard/#/nc/project-id/login-table-id
|
||||
NOCODB_SETTINGS_SHEET=https://your-nocodb.com/dashboard/#/nc/project-id/settings-table-id
|
||||
```
|
||||
|
||||
6. **Build and Deploy**
|
||||
|
||||
Build the Docker image and start the application:
|
||||
```bash
|
||||
# Build the Docker image
|
||||
docker-compose build
|
||||
|
||||
# Start the application
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
7. **Verify Installation**
|
||||
|
||||
- Check container status: `docker-compose ps`
|
||||
- View logs: `docker-compose logs -f map-viewer`
|
||||
- Access the application at: http://localhost:3000
|
||||
|
||||
## Database Schema
|
||||
|
||||
The build script automatically creates the following table structure:
|
||||
|
||||
### Main Locations Table
|
||||
- `Geo-Location` (Geo-Data): Format "latitude;longitude"
|
||||
- `latitude` (Decimal): Precision 10, Scale 8
|
||||
- `longitude` (Decimal): Precision 11, Scale 8
|
||||
@ -46,14 +127,12 @@ A containerized web application that visualizes geographic data from NocoDB on a
|
||||
- `title` (Text): Location name (legacy field)
|
||||
- `category` (Single Select): Classification (legacy field)
|
||||
|
||||
2. **Login Table** - Create a table for user authentication:
|
||||
|
||||
### Login Table
|
||||
- `Email` (Email): User email address
|
||||
- `Name` (Single Line Text): User display name
|
||||
- `Admin` (Checkbox): Admin privileges
|
||||
|
||||
3. **Settings Table** - Create a table for admin configuration:
|
||||
|
||||
### Settings Table
|
||||
- `key` (Single Line Text): Setting identifier
|
||||
- `title` (Single Line Text): Display name
|
||||
- `value` (Long Text): Setting value
|
||||
@ -68,44 +147,6 @@ A containerized web application that visualizes geographic data from NocoDB on a
|
||||
- `qr_code_2_image` (Attachment): QR code 2 image
|
||||
- `qr_code_3_image` (Attachment): QR code 3 image
|
||||
|
||||
### Installation
|
||||
|
||||
1. Clone this repository or create the file structure as shown
|
||||
|
||||
2. Copy the environment template:
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
3. Edit `.env` with your NocoDB details:
|
||||
```env
|
||||
NOCODB_API_URL=https://db.lindalindsay.org/api/v1
|
||||
NOCODB_API_TOKEN=your-token-here
|
||||
NOCODB_VIEW_URL=https://db.lindalindsay.org/dashboard/#/nc/p406kno3lbq4zmq/mvtryxrvze6td79
|
||||
NOCODB_LOGIN_SHEET=https://db.lindalindsay.org/dashboard/#/nc/p406kno3lbq4zmq/login_sheet_id
|
||||
NOCODB_SETTINGS_SHEET=https://db.lindalindsay.org/dashboard/#/nc/p406kno3lbq4zmq/settings_sheet_id
|
||||
```
|
||||
|
||||
4. Start the application:
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
5. Access the map at: http://localhost:3000
|
||||
|
||||
## Finding NocoDB IDs
|
||||
|
||||
### API Token
|
||||
|
||||
1. Click user icon → Account Settings
|
||||
2. Go to "API Tokens" tab
|
||||
3. Create new token with read/write permissions
|
||||
|
||||
### Project and Table IDs
|
||||
|
||||
- Simply provide the full NocoDB view URL in `NOCODB_VIEW_URL`
|
||||
- The system will automatically extract the project and table IDs
|
||||
|
||||
## API Endpoints
|
||||
|
||||
### Public Endpoints
|
||||
@ -183,6 +224,28 @@ All configuration is done via environment variables:
|
||||
| `DEFAULT_LNG` | Default map longitude | -113.4938 |
|
||||
| `DEFAULT_ZOOM` | Default map zoom level | 11 |
|
||||
|
||||
## Maintenance Commands
|
||||
|
||||
### Update Application
|
||||
```bash
|
||||
docker-compose down
|
||||
git pull origin main
|
||||
docker-compose build
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### Development Mode
|
||||
```bash
|
||||
cd app
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### Health Check
|
||||
```bash
|
||||
curl http://localhost:3000/health
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
To run in development mode:
|
||||
@ -226,6 +289,12 @@ To run in development mode:
|
||||
- Check API URL format
|
||||
- Confirm network connectivity
|
||||
|
||||
### Build Script Issues
|
||||
|
||||
- Ensure NocoDB instance is accessible
|
||||
- Verify API token has admin permissions
|
||||
- Check that the NocoDB database is clean (delete all bases before running)
|
||||
|
||||
## License
|
||||
|
||||
MIT License - See LICENSE file for details
|
||||
@ -237,8 +306,7 @@ For issues or questions:
|
||||
2. Review NocoDB documentation
|
||||
3. Open an issue on GitHub
|
||||
|
||||
# Known Bugs
|
||||
## Known Bugs
|
||||
|
||||
- First load of page often fails, need to debug
|
||||
- want ui for dots tohave a edit button that then brings up the form.
|
||||
-
|
||||
- Want UI for dots to have an edit button that then brings up the form
|
||||
@ -7,10 +7,10 @@
|
||||
"stars_count": 0,
|
||||
"forks_count": 0,
|
||||
"open_issues_count": 0,
|
||||
"updated_at": "2025-07-05T23:14:45-06:00",
|
||||
"updated_at": "2025-07-06T15:58:19-06:00",
|
||||
"created_at": "2025-05-28T14:54:59-06:00",
|
||||
"clone_url": "https://gitea.bnkops.com/admin/changemaker.lite.git",
|
||||
"ssh_url": "git@gitea.bnkops.com:admin/changemaker.lite.git",
|
||||
"default_branch": "main",
|
||||
"last_build_update": "2025-07-05T23:14:45-06:00"
|
||||
"last_build_update": "2025-07-06T15:58:19-06:00"
|
||||
}
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "Claude Code is an agentic coding tool that lives in your terminal, understands your codebase, and helps you code faster by executing routine tasks, explaining complex code, and handling git workflows - all through natural language commands.",
|
||||
"html_url": "https://github.com/anthropics/claude-code",
|
||||
"language": "PowerShell",
|
||||
"stars_count": 17581,
|
||||
"forks_count": 977,
|
||||
"open_issues_count": 1616,
|
||||
"updated_at": "2025-07-06T05:36:02Z",
|
||||
"stars_count": 17706,
|
||||
"forks_count": 990,
|
||||
"open_issues_count": 1655,
|
||||
"updated_at": "2025-07-06T22:00:25Z",
|
||||
"created_at": "2025-02-22T17:41:21Z",
|
||||
"clone_url": "https://github.com/anthropics/claude-code.git",
|
||||
"ssh_url": "git@github.com:anthropics/claude-code.git",
|
||||
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "VS Code in the browser",
|
||||
"html_url": "https://github.com/coder/code-server",
|
||||
"language": "TypeScript",
|
||||
"stars_count": 72703,
|
||||
"forks_count": 6078,
|
||||
"stars_count": 72722,
|
||||
"forks_count": 6079,
|
||||
"open_issues_count": 144,
|
||||
"updated_at": "2025-07-06T05:59:54Z",
|
||||
"updated_at": "2025-07-06T21:49:09Z",
|
||||
"created_at": "2019-02-27T16:50:41Z",
|
||||
"clone_url": "https://github.com/coder/code-server.git",
|
||||
"ssh_url": "git@github.com:coder/code-server.git",
|
||||
|
||||
@ -4,13 +4,13 @@
|
||||
"description": "A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.",
|
||||
"html_url": "https://github.com/gethomepage/homepage",
|
||||
"language": "JavaScript",
|
||||
"stars_count": 24660,
|
||||
"forks_count": 1526,
|
||||
"stars_count": 24669,
|
||||
"forks_count": 1524,
|
||||
"open_issues_count": 2,
|
||||
"updated_at": "2025-07-06T05:23:44Z",
|
||||
"updated_at": "2025-07-06T21:55:31Z",
|
||||
"created_at": "2022-08-24T07:29:42Z",
|
||||
"clone_url": "https://github.com/gethomepage/homepage.git",
|
||||
"ssh_url": "git@github.com:gethomepage/homepage.git",
|
||||
"default_branch": "dev",
|
||||
"last_build_update": "2025-07-06T00:40:33Z"
|
||||
"last_build_update": "2025-07-06T12:12:22Z"
|
||||
}
|
||||
@ -4,13 +4,13 @@
|
||||
"description": "Git with a cup of tea! Painless self-hosted all-in-one software development service, including Git hosting, code review, team collaboration, package registry and CI/CD",
|
||||
"html_url": "https://github.com/go-gitea/gitea",
|
||||
"language": "Go",
|
||||
"stars_count": 49388,
|
||||
"forks_count": 5897,
|
||||
"open_issues_count": 2708,
|
||||
"updated_at": "2025-07-06T05:36:50Z",
|
||||
"stars_count": 49399,
|
||||
"forks_count": 5899,
|
||||
"open_issues_count": 2699,
|
||||
"updated_at": "2025-07-06T22:00:34Z",
|
||||
"created_at": "2016-11-01T02:13:26Z",
|
||||
"clone_url": "https://github.com/go-gitea/gitea.git",
|
||||
"ssh_url": "git@github.com:go-gitea/gitea.git",
|
||||
"default_branch": "main",
|
||||
"last_build_update": "2025-07-06T05:36:45Z"
|
||||
"last_build_update": "2025-07-06T17:47:03Z"
|
||||
}
|
||||
@ -4,13 +4,13 @@
|
||||
"description": "High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.",
|
||||
"html_url": "https://github.com/knadh/listmonk",
|
||||
"language": "Go",
|
||||
"stars_count": 17265,
|
||||
"stars_count": 17268,
|
||||
"forks_count": 1661,
|
||||
"open_issues_count": 97,
|
||||
"updated_at": "2025-07-06T04:14:35Z",
|
||||
"open_issues_count": 96,
|
||||
"updated_at": "2025-07-06T20:56:08Z",
|
||||
"created_at": "2019-06-26T05:08:39Z",
|
||||
"clone_url": "https://github.com/knadh/listmonk.git",
|
||||
"ssh_url": "git@github.com:knadh/listmonk.git",
|
||||
"default_branch": "master",
|
||||
"last_build_update": "2025-07-05T13:20:25Z"
|
||||
"last_build_update": "2025-07-06T16:27:00Z"
|
||||
}
|
||||
@ -5,7 +5,7 @@
|
||||
"html_url": "https://github.com/lyqht/mini-qr",
|
||||
"language": "Vue",
|
||||
"stars_count": 1259,
|
||||
"forks_count": 164,
|
||||
"forks_count": 165,
|
||||
"open_issues_count": 13,
|
||||
"updated_at": "2025-07-05T15:44:11Z",
|
||||
"created_at": "2023-04-21T14:20:14Z",
|
||||
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "Fair-code workflow automation platform with native AI capabilities. Combine visual building with custom code, self-host or cloud, 400+ integrations.",
|
||||
"html_url": "https://github.com/n8n-io/n8n",
|
||||
"language": "TypeScript",
|
||||
"stars_count": 115275,
|
||||
"forks_count": 34061,
|
||||
"open_issues_count": 1080,
|
||||
"updated_at": "2025-07-06T05:59:18Z",
|
||||
"stars_count": 115465,
|
||||
"forks_count": 34173,
|
||||
"open_issues_count": 1083,
|
||||
"updated_at": "2025-07-06T21:58:19Z",
|
||||
"created_at": "2019-06-22T09:24:21Z",
|
||||
"clone_url": "https://github.com/n8n-io/n8n.git",
|
||||
"ssh_url": "git@github.com:n8n-io/n8n.git",
|
||||
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "\ud83d\udd25 \ud83d\udd25 \ud83d\udd25 Open Source Airtable Alternative",
|
||||
"html_url": "https://github.com/nocodb/nocodb",
|
||||
"language": "TypeScript",
|
||||
"stars_count": 55551,
|
||||
"forks_count": 3997,
|
||||
"stars_count": 55571,
|
||||
"forks_count": 3998,
|
||||
"open_issues_count": 717,
|
||||
"updated_at": "2025-07-06T04:11:36Z",
|
||||
"updated_at": "2025-07-06T21:38:01Z",
|
||||
"created_at": "2017-10-29T18:51:48Z",
|
||||
"clone_url": "https://github.com/nocodb/nocodb.git",
|
||||
"ssh_url": "git@github.com:nocodb/nocodb.git",
|
||||
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "Get up and running with Llama 3.3, DeepSeek-R1, Phi-4, Gemma 3, Mistral Small 3.1 and other large language models.",
|
||||
"html_url": "https://github.com/ollama/ollama",
|
||||
"language": "Go",
|
||||
"stars_count": 145672,
|
||||
"forks_count": 12305,
|
||||
"open_issues_count": 1858,
|
||||
"updated_at": "2025-07-06T05:29:22Z",
|
||||
"stars_count": 145726,
|
||||
"forks_count": 12310,
|
||||
"open_issues_count": 1863,
|
||||
"updated_at": "2025-07-06T22:05:47Z",
|
||||
"created_at": "2023-06-26T19:39:32Z",
|
||||
"clone_url": "https://github.com/ollama/ollama.git",
|
||||
"ssh_url": "git@github.com:ollama/ollama.git",
|
||||
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "Documentation that simply works",
|
||||
"html_url": "https://github.com/squidfunk/mkdocs-material",
|
||||
"language": "Python",
|
||||
"stars_count": 23806,
|
||||
"stars_count": 23814,
|
||||
"forks_count": 3793,
|
||||
"open_issues_count": 7,
|
||||
"updated_at": "2025-07-06T00:58:35Z",
|
||||
"open_issues_count": 6,
|
||||
"updated_at": "2025-07-06T20:06:57Z",
|
||||
"created_at": "2016-01-28T22:09:23Z",
|
||||
"clone_url": "https://github.com/squidfunk/mkdocs-material.git",
|
||||
"ssh_url": "git@github.com:squidfunk/mkdocs-material.git",
|
||||
|
||||
9
mkdocs/docs/build/site.md
vendored
9
mkdocs/docs/build/site.md
vendored
@ -4,6 +4,15 @@ Welcome! This guide will help you get started building and customizing your site
|
||||
|
||||
---
|
||||
|
||||
## Reset Site
|
||||
|
||||
You can read through all the BNKops cmlite documentation already in your docs folder or you can reset your docs folder to a baseline to start and read more manuals at [cmlite.org](cmlite.org). To reset docs folder to baseline, run the following:
|
||||
|
||||
```bash
|
||||
./reset-site.sh
|
||||
```
|
||||
|
||||
|
||||
## 🚀 How to Build Your Site (Step by Step)
|
||||
|
||||
1. **Open your Coder instance.**
|
||||
|
||||
@ -7,10 +7,10 @@
|
||||
"stars_count": 0,
|
||||
"forks_count": 0,
|
||||
"open_issues_count": 0,
|
||||
"updated_at": "2025-07-05T23:14:45-06:00",
|
||||
"updated_at": "2025-07-06T15:58:19-06:00",
|
||||
"created_at": "2025-05-28T14:54:59-06:00",
|
||||
"clone_url": "https://gitea.bnkops.com/admin/changemaker.lite.git",
|
||||
"ssh_url": "git@gitea.bnkops.com:admin/changemaker.lite.git",
|
||||
"default_branch": "main",
|
||||
"last_build_update": "2025-07-05T23:14:45-06:00"
|
||||
"last_build_update": "2025-07-06T15:58:19-06:00"
|
||||
}
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "Claude Code is an agentic coding tool that lives in your terminal, understands your codebase, and helps you code faster by executing routine tasks, explaining complex code, and handling git workflows - all through natural language commands.",
|
||||
"html_url": "https://github.com/anthropics/claude-code",
|
||||
"language": "PowerShell",
|
||||
"stars_count": 17581,
|
||||
"forks_count": 977,
|
||||
"open_issues_count": 1616,
|
||||
"updated_at": "2025-07-06T05:36:02Z",
|
||||
"stars_count": 17706,
|
||||
"forks_count": 990,
|
||||
"open_issues_count": 1655,
|
||||
"updated_at": "2025-07-06T22:00:25Z",
|
||||
"created_at": "2025-02-22T17:41:21Z",
|
||||
"clone_url": "https://github.com/anthropics/claude-code.git",
|
||||
"ssh_url": "git@github.com:anthropics/claude-code.git",
|
||||
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "VS Code in the browser",
|
||||
"html_url": "https://github.com/coder/code-server",
|
||||
"language": "TypeScript",
|
||||
"stars_count": 72703,
|
||||
"forks_count": 6078,
|
||||
"stars_count": 72722,
|
||||
"forks_count": 6079,
|
||||
"open_issues_count": 144,
|
||||
"updated_at": "2025-07-06T05:59:54Z",
|
||||
"updated_at": "2025-07-06T21:49:09Z",
|
||||
"created_at": "2019-02-27T16:50:41Z",
|
||||
"clone_url": "https://github.com/coder/code-server.git",
|
||||
"ssh_url": "git@github.com:coder/code-server.git",
|
||||
|
||||
@ -4,13 +4,13 @@
|
||||
"description": "A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.",
|
||||
"html_url": "https://github.com/gethomepage/homepage",
|
||||
"language": "JavaScript",
|
||||
"stars_count": 24660,
|
||||
"forks_count": 1526,
|
||||
"stars_count": 24669,
|
||||
"forks_count": 1524,
|
||||
"open_issues_count": 2,
|
||||
"updated_at": "2025-07-06T05:23:44Z",
|
||||
"updated_at": "2025-07-06T21:55:31Z",
|
||||
"created_at": "2022-08-24T07:29:42Z",
|
||||
"clone_url": "https://github.com/gethomepage/homepage.git",
|
||||
"ssh_url": "git@github.com:gethomepage/homepage.git",
|
||||
"default_branch": "dev",
|
||||
"last_build_update": "2025-07-06T00:40:33Z"
|
||||
"last_build_update": "2025-07-06T12:12:22Z"
|
||||
}
|
||||
@ -4,13 +4,13 @@
|
||||
"description": "Git with a cup of tea! Painless self-hosted all-in-one software development service, including Git hosting, code review, team collaboration, package registry and CI/CD",
|
||||
"html_url": "https://github.com/go-gitea/gitea",
|
||||
"language": "Go",
|
||||
"stars_count": 49388,
|
||||
"forks_count": 5897,
|
||||
"open_issues_count": 2708,
|
||||
"updated_at": "2025-07-06T05:36:50Z",
|
||||
"stars_count": 49399,
|
||||
"forks_count": 5899,
|
||||
"open_issues_count": 2699,
|
||||
"updated_at": "2025-07-06T22:00:34Z",
|
||||
"created_at": "2016-11-01T02:13:26Z",
|
||||
"clone_url": "https://github.com/go-gitea/gitea.git",
|
||||
"ssh_url": "git@github.com:go-gitea/gitea.git",
|
||||
"default_branch": "main",
|
||||
"last_build_update": "2025-07-06T05:36:45Z"
|
||||
"last_build_update": "2025-07-06T17:47:03Z"
|
||||
}
|
||||
@ -4,13 +4,13 @@
|
||||
"description": "High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.",
|
||||
"html_url": "https://github.com/knadh/listmonk",
|
||||
"language": "Go",
|
||||
"stars_count": 17265,
|
||||
"stars_count": 17268,
|
||||
"forks_count": 1661,
|
||||
"open_issues_count": 97,
|
||||
"updated_at": "2025-07-06T04:14:35Z",
|
||||
"open_issues_count": 96,
|
||||
"updated_at": "2025-07-06T20:56:08Z",
|
||||
"created_at": "2019-06-26T05:08:39Z",
|
||||
"clone_url": "https://github.com/knadh/listmonk.git",
|
||||
"ssh_url": "git@github.com:knadh/listmonk.git",
|
||||
"default_branch": "master",
|
||||
"last_build_update": "2025-07-05T13:20:25Z"
|
||||
"last_build_update": "2025-07-06T16:27:00Z"
|
||||
}
|
||||
@ -5,7 +5,7 @@
|
||||
"html_url": "https://github.com/lyqht/mini-qr",
|
||||
"language": "Vue",
|
||||
"stars_count": 1259,
|
||||
"forks_count": 164,
|
||||
"forks_count": 165,
|
||||
"open_issues_count": 13,
|
||||
"updated_at": "2025-07-05T15:44:11Z",
|
||||
"created_at": "2023-04-21T14:20:14Z",
|
||||
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "Fair-code workflow automation platform with native AI capabilities. Combine visual building with custom code, self-host or cloud, 400+ integrations.",
|
||||
"html_url": "https://github.com/n8n-io/n8n",
|
||||
"language": "TypeScript",
|
||||
"stars_count": 115275,
|
||||
"forks_count": 34061,
|
||||
"open_issues_count": 1080,
|
||||
"updated_at": "2025-07-06T05:59:18Z",
|
||||
"stars_count": 115465,
|
||||
"forks_count": 34173,
|
||||
"open_issues_count": 1083,
|
||||
"updated_at": "2025-07-06T21:58:19Z",
|
||||
"created_at": "2019-06-22T09:24:21Z",
|
||||
"clone_url": "https://github.com/n8n-io/n8n.git",
|
||||
"ssh_url": "git@github.com:n8n-io/n8n.git",
|
||||
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "\ud83d\udd25 \ud83d\udd25 \ud83d\udd25 Open Source Airtable Alternative",
|
||||
"html_url": "https://github.com/nocodb/nocodb",
|
||||
"language": "TypeScript",
|
||||
"stars_count": 55551,
|
||||
"forks_count": 3997,
|
||||
"stars_count": 55571,
|
||||
"forks_count": 3998,
|
||||
"open_issues_count": 717,
|
||||
"updated_at": "2025-07-06T04:11:36Z",
|
||||
"updated_at": "2025-07-06T21:38:01Z",
|
||||
"created_at": "2017-10-29T18:51:48Z",
|
||||
"clone_url": "https://github.com/nocodb/nocodb.git",
|
||||
"ssh_url": "git@github.com:nocodb/nocodb.git",
|
||||
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "Get up and running with Llama 3.3, DeepSeek-R1, Phi-4, Gemma 3, Mistral Small 3.1 and other large language models.",
|
||||
"html_url": "https://github.com/ollama/ollama",
|
||||
"language": "Go",
|
||||
"stars_count": 145672,
|
||||
"forks_count": 12305,
|
||||
"open_issues_count": 1858,
|
||||
"updated_at": "2025-07-06T05:29:22Z",
|
||||
"stars_count": 145726,
|
||||
"forks_count": 12310,
|
||||
"open_issues_count": 1863,
|
||||
"updated_at": "2025-07-06T22:05:47Z",
|
||||
"created_at": "2023-06-26T19:39:32Z",
|
||||
"clone_url": "https://github.com/ollama/ollama.git",
|
||||
"ssh_url": "git@github.com:ollama/ollama.git",
|
||||
|
||||
@ -4,10 +4,10 @@
|
||||
"description": "Documentation that simply works",
|
||||
"html_url": "https://github.com/squidfunk/mkdocs-material",
|
||||
"language": "Python",
|
||||
"stars_count": 23806,
|
||||
"stars_count": 23814,
|
||||
"forks_count": 3793,
|
||||
"open_issues_count": 7,
|
||||
"updated_at": "2025-07-06T00:58:35Z",
|
||||
"open_issues_count": 6,
|
||||
"updated_at": "2025-07-06T20:06:57Z",
|
||||
"created_at": "2016-01-28T22:09:23Z",
|
||||
"clone_url": "https://github.com/squidfunk/mkdocs-material.git",
|
||||
"ssh_url": "git@github.com:squidfunk/mkdocs-material.git",
|
||||
|
||||
@ -674,6 +674,15 @@ Changemaker Archive. <a href="https://docs.bnkops.com">Learn more</a>
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#reset-site" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Reset Site
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#how-to-build-your-site-step-by-step" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@ -1463,6 +1472,15 @@ Changemaker Archive. <a href="https://docs.bnkops.com">Learn more</a>
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#reset-site" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Reset Site
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#how-to-build-your-site-step-by-step" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@ -1527,17 +1545,21 @@ Changemaker Archive. <a href="https://docs.bnkops.com">Learn more</a>
|
||||
<h1 id="building-the-site-with-mkdocs-material">Building the Site with MkDocs Material<a class="headerlink" href="#building-the-site-with-mkdocs-material" title="Permanent link">¶</a></h1>
|
||||
<p>Welcome! This guide will help you get started building and customizing your site using <a href="https://squidfunk.github.io/mkdocs-material/">MkDocs Material</a>.</p>
|
||||
<hr />
|
||||
<h2 id="reset-site">Reset Site<a class="headerlink" href="#reset-site" title="Permanent link">¶</a></h2>
|
||||
<p>You can read through all the BNKops cmlite documentation already in your docs folder or you can reset your docs folder to a baseline to start and read more manuals at <a href="cmlite.org">cmlite.org</a>. To reset docs folder to baseline, run the following: </p>
|
||||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>./reset-site.sh
|
||||
</span></code></pre></div>
|
||||
<h2 id="how-to-build-your-site-step-by-step">🚀 How to Build Your Site (Step by Step)<a class="headerlink" href="#how-to-build-your-site-step-by-step" title="Permanent link">¶</a></h2>
|
||||
<ol>
|
||||
<li><strong>Open your Coder instance.</strong>
|
||||
For example: coder.yourdomain.com</li>
|
||||
<li><strong>Go to the mkdocs folder:</strong><br />
|
||||
In the terminal (for a new terminal press Crtl - Shift - ~), type:
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nb">cd</span><span class="w"> </span>mkdocs
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nb">cd</span><span class="w"> </span>mkdocs
|
||||
</span></code></pre></div></li>
|
||||
<li><strong>Build the site:</strong><br />
|
||||
Type:
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>mkdocs<span class="w"> </span>build
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>mkdocs<span class="w"> </span>build
|
||||
</span></code></pre></div>
|
||||
This creates the static website from your documents and places them in the <code>mkdocs/site</code> directory.</li>
|
||||
</ol>
|
||||
@ -1590,7 +1612,7 @@ Changemaker Archive. <a href="https://docs.bnkops.com">Learn more</a>
|
||||
<ul>
|
||||
<li>If you have a <a href="https://claude.ai/">claude.ai</a> subscription, you can use powerful AI in your Coder terminal to write or rewrite pages, including a new <code>home.html</code>.</li>
|
||||
<li>All you need to do is open the terminal and type:
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>claude
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>claude
|
||||
</span></code></pre></div></li>
|
||||
<li>You can also try local AI tools like <a href="https://ollama.com/">Ollama</a> for on-demand help.</li>
|
||||
</ul>
|
||||
|
||||
File diff suppressed because one or more lines are too long
Loading…
x
Reference in New Issue
Block a user