Skip to content

Latest commit

 

History

History
92 lines (64 loc) · 2.19 KB

README.md

File metadata and controls

92 lines (64 loc) · 2.19 KB
Raw

AI Programming Teaching Project

A modern educational platform built with Docusaurus to teach AI-assisted programming and development practices. This project aims to help developers learn how to effectively use AI tools and improve their development workflow.

Features

  • 📚 Comprehensive learning modules covering basics to advanced topics
  • 🛠️ Practical guides for modern development tools (Cursor, v0, Vercel)
  • 💻 Hands-on project examples and exercises
  • 🌐 Bilingual support (English and Chinese)
  • 🎨 Modern, responsive UI with dark mode support
  • ⚡ Fast, optimized performance

Core Topics

  • AI Communication and Prompt Engineering
  • Markdown and Documentation Best Practices
  • Development Tools and Workflows
  • Project Planning and Implementation
  • Deployment and Maintenance

Getting Started

Prerequisites

  • Node.js >=18.0
  • Git
  • GitHub account

Installation

  1. Clone the repository:
git clone https://github.com/ChanMeng666/ai-programming-teaching-project.git
  1. Install dependencies:
cd ai-programming-teaching-project
npm install
  1. Start the development server:
npm start

The site will be available at http://localhost:3000

Building for Production

npm run build

Project Structure

project-root/
├── docs/             # Documentation content
├── blog/             # Blog posts
├── src/              
│   ├── components/   # React components
│   ├── css/          # Style files
│   └── pages/        # Static pages
├── static/           # Static assets
└── docusaurus.config.js  # Main configuration

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

Acknowledgments

Built with Docusaurus and deployed on Vercel

Author

Chan Meng