Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chanmeng666/ai-programming-teaching-project
An educational platform built with Docusaurus for learning AI-assisted programming and development.
https://github.com/chanmeng666/ai-programming-teaching-project
ai-programming documentation docusaurus educational markdown programming-education programming-tutorials react technical-documentation web-development
Last synced: 15 days ago
JSON representation
An educational platform built with Docusaurus for learning AI-assisted programming and development.
- Host: GitHub
- URL: https://github.com/chanmeng666/ai-programming-teaching-project
- Owner: ChanMeng666
- Created: 2024-11-19T02:51:19.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-05T21:49:24.000Z (18 days ago)
- Last Synced: 2024-12-05T22:27:36.475Z (18 days ago)
- Topics: ai-programming, documentation, docusaurus, educational, markdown, programming-education, programming-tutorials, react, technical-documentation, web-development
- Language: CSS
- Homepage: https://ai-programming-teaching-project.vercel.app
- Size: 361 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
AI Programming Education Platform
A modern educational platform that teaches AI-assisted programming through comprehensive tutorials, hands-on projects, and best practices. Built with Docusaurus and designed to help developers effectively use AI tools to enhance their development workflow.
# ✨ Features
### 📚 Comprehensive Learning Path
- Step-by-step tutorials from basics to advanced topics
- Hands-on exercises and real-world projects
- Best practices for AI-assisted development
### 🛠️ Modern Development Tools
- Integration guides for Cursor, v0, and Vercel
- Workflow optimization techniques
- Project planning and implementation strategies
### 💻 Interactive Learning Experience
- Bilingual support (English & Chinese)
- Modern, responsive UI with dark mode
- Rich multimedia content and examples
### 🌟 Key Topics Covered
- AI Communication & Prompt Engineering
- Markdown & Documentation Best Practices
- Development Tools & Workflows
- Project Planning & Implementation
- Deployment & Maintenance
## 🚀 Getting Started
### Prerequisites
- Node.js ≥ 18.0
- Git
- GitHub account
### Installation
1. Clone the repository:
```bash
git clone https://github.com/ChanMeng666/ai-programming-teaching-project.git
```
2. Install dependencies:
```bash
cd ai-programming-teaching-project
npm install
```
3. Start the development server:
```bash
npm start
```
The site will be available at `http://localhost:3000`
### Building for Production
```bash
npm run build
```
## 🔧 Tech Stack
## 📁 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. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## 📝 License
This project is licensed under the MIT License - see the LICENSE file for details.
## 📧 Contact
**Chan Meng**
- Website: [chanmeng.live](https://chanmeng.live)
- GitHub: [@ChanMeng666](https://github.com/ChanMeng666)
- LinkedIn: [chanmeng666](https://www.linkedin.com/in/chanmeng666)
## 🙏 Acknowledgments
Built with [Docusaurus](https://docusaurus.io/) and deployed on [Vercel](https://vercel.com)