Frontend Knowledge Structure - Deploy & Usage Guide

Prerequisites

• Runtime: None required (this is a static knowledge structure project)
• Tools: Git, Node.js (for local development and visualization)
• Browser: Modern browser (Chrome, Firefox, Safari, Edge) for viewing the knowledge structure

Installation

1. Clone the repository

git clone https://github.com/JacksonTian/fks.git
cd fks

2. Install dependencies (for visualization features)

cd fks_chart
npm install

Configuration

No specific configuration is required for the static knowledge structure. For the visualization component:

• No environment variables needed
• No API keys required
• The visualization runs entirely client-side

Build & Run

Local Development

1. Start the visualization server

cd fks_chart
npm start

2. View the visualization

• Open your browser and navigate to http://localhost:8080
• The interactive knowledge structure chart will be displayed

Static Content

The knowledge structure is available as static markdown files in the repository root. You can view these directly in any markdown viewer or editor.

Deployment

Static Hosting (Recommended)

Since this is primarily a static knowledge structure, deploy to any static hosting service:

1. GitHub Pages

# Deploy the main content
# (The visualization component can be deployed separately if needed)

2. Netlify/Vercel

• Connect your repository
• Deploy the root directory as a static site

Visualization Component

If you want to deploy the interactive visualization separately:

1. Build the visualization

cd fks_chart
npm run build

2. Deploy to static hosting

• The built files will be in the dist folder
• Deploy to any static hosting service

Troubleshooting

Common Issues

1. "npm install" fails

   • Ensure Node.js is installed and up to date
   • Try clearing npm cache: npm cache clean --force

2. Visualization not loading

   • Check that you're running npm start from the fks_chart directory
   • Ensure port 8080 is not blocked by firewall

3. Markdown not rendering properly

   • The main content is markdown - use a markdown viewer if not rendering in browser
   • All markdown files are in the root directory

4. Dependencies outdated

   • Run npm update in the fks_chart directory to update dependencies

Support

• This is a knowledge structure project, not a running application
• For issues with the visualization component, check the fks_chart directory
• The main content (knowledge structure) is static and should work in any environment