@@ -6,12 +6,14 @@ A comprehensive GitHub toolkit built with Next.js frontend and Flask API. Analyz
66
77- ** [ Getting Started] ( ./docs/GETTING_STARTED.md ) ** - Installation, setup, and troubleshooting guide
88- ** [ Features] ( ./docs/FEATURES.md ) ** - Detailed feature descriptions and capabilities
9+ - ** [ Code Quality] ( ./docs/CODE_QUALITY.md ) ** - Code quality tools, linting, formatting, and type safety
910- ** [ Technical Details] ( ./docs/TECHNICAL_DETAILS.md ) ** - Tech stack, architecture, and deployment
1011- ** [ GitHub API Integration] ( ./docs/GITHUB_API_INTEGRATION.md ) ** - API endpoints and integration details
1112
1213## 🚀 Quick Start
1314
1415### Prerequisites
16+
1517- Node.js 18+ and yarn
1618- Python 3.8+
1719- Git
@@ -20,12 +22,14 @@ A comprehensive GitHub toolkit built with Next.js frontend and Flask API. Analyz
2022### Setup
2123
2224** 1. Clone the repository:**
25+
2326``` bash
2427git clone < repository-url>
2528cd github-toolkit
2629```
2730
2831** 2. Backend setup:**
32+
2933``` bash
3034pip install -r requirements.txt
3135cp .env.example .env
@@ -35,12 +39,14 @@ python -m flask --app api/index run -p 5328
3539```
3640
3741** 3. Frontend setup (new terminal):**
42+
3843``` bash
3944yarn
4045yarn next-dev
4146```
4247
4348** 4. Access the application:**
49+
4450- Frontend: http://localhost:3000
4551- Backend API: http://localhost:5328
4652
@@ -52,11 +58,13 @@ yarn next-dev
5258## 💻 Development
5359
5460** Run both frontend and backend concurrently:**
61+
5562``` bash
5663yarn dev
5764```
5865
5966Or run them separately:
67+
6068``` bash
6169# Terminal 1
6270python -m flask --app api/index run -p 5328
@@ -66,6 +74,7 @@ yarn next-dev
6674```
6775
6876** Build for production:**
77+
6978``` bash
7079yarn build
7180yarn start
@@ -75,6 +84,7 @@ yarn start
7584
7685- For detailed setup and troubleshooting, see [ Getting Started] ( ./docs/GETTING_STARTED.md )
7786- For feature descriptions, see [ Features] ( ./docs/FEATURES.md )
87+ - For code quality standards, see [ Code Quality] ( ./docs/CODE_QUALITY.md )
7888- For technical architecture, see [ Technical Details] ( ./docs/TECHNICAL_DETAILS.md )
7989- For API integration details, see [ GitHub API Integration] ( ./docs/GITHUB_API_INTEGRATION.md )
8090
@@ -89,6 +99,7 @@ We welcome contributions! Please follow these steps:
89995 . Open a Pull Request
90100
91101### Code Standards
102+
92103- Use TypeScript for frontend code
93104- Maintain clean, readable code with proper comments
94105- Test your changes thoroughly before submitting
0 commit comments