https://github.com/302ai/302_starter
302.AI tool template
https://github.com/302ai/302_starter
Last synced: 3 months ago
JSON representation
302.AI tool template
- Host: GitHub
- URL: https://github.com/302ai/302_starter
- Owner: 302ai
- License: mit
- Created: 2024-11-26T06:19:12.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-02-28T06:38:35.000Z (3 months ago)
- Last Synced: 2025-02-28T13:49:30.689Z (3 months ago)
- Language: TypeScript
- Size: 2.75 MB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#
π€ 302 Starterπβ¨
302 Starter is a modern web application starter template based on Next.js 14, integrating the latest frontend tech stack and best practices.
## β¨ About 302.AI β¨
[302.AI](https://302.ai) is a pay-as-you-go AI application platform, bridging the gap between AI capabilities and practical implementation.
1. π§ Comprehensive AI capabilities: Incorporates the latest in language, image, audio, and video models from leading AI brands.
2. π Advanced application development: We build genuine AI products, not just simple chatbots.
3. π° No monthly fees: All features are pay-per-use, fully accessible, ensuring low entry barriers with high potential.
4. π Powerful admin dashboard: Designed for teams and SMEs - managed by one, used by many.
5. π API access for all AI features: All tools are open-source and customizable (in progress).
6. π‘ Powerful development team: Launching 2-3 new applications weekly with daily product updates. Interested developers are welcome to contact us.
## π Project Introduction
This is a feature-rich Next.js starter template that adopts the App Router architecture and integrates multiple practical features such as 302AI authentication, internationalization, theme switching, and form handling. The project is developed using TypeScript, ensuring code type safety and maintainability.
## π Project Structure
```
src/
βββ actions/ # Server actions
βββ api/ # API routes
βββ app/ # Next.js app router
βββ components/ # React components
βββ constants/ # Constants
βββ hooks/ # Custom React Hooks
βββ i18n/ # Internationalization
βββ lib/ # Libraries
βββ services/ # Services
βββ stores/ # State management
βββ styles/ # Styles
βββ utils/ # Utilities
```
## π οΈ Tech Stack
- **Framework**: Next.js 14
- **Language**: TypeScript
- **Styling**: TailwindCSS
- **UI Components**: Radix UI
- **State Management**: Jotai
- **Form Handling**: React Hook Form
- **HTTP Client**: ky
- **i18n**: next-intl
- **Theming**: next-themes
- **Code Standards**: ESLint, Prettier
- **Commit Standards**: Husky, Commitlint
## π Installation & Setup
### βοΈ Requirements
- Node.js 18.17 or higher
- pnpm 8.0 or higher
### π₯ Installation Steps
1. Clone the project
```bash
git clone [repository-url]
cd 302-starter
```
2. Install dependencies
```bash
pnpm install
```
3. Configure environment
```bash
cp .env.example .env.local
```
Modify the environment variables in `.env.local` as needed.
4. Start development server
```bash
pnpm dev
```
5. Build for production
```bash
pnpm build
pnpm start
```
## β¨ Key Features
- π 302AI Authentication
- π Internationalization
- π¨ Light/Dark Theme
- π Form Validation
- π Type-safe API Calls
- π¦ Modular Components
- π Optimized Build
- π§ Complete Development Toolchain
## π Code Standards
The project uses ESLint and Prettier for code formatting and standards:
- β
ESLint: Code quality
- π¨ Prettier: Code formatting
- π Husky: Git hooks
- π Commitlint: Commit message standards
Run code check:
```bash
pnpm lint
```
## π€ Contributing
1. Fork the project
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### π Commit Convention
The project follows [Conventional Commits](https://www.conventionalcommits.org/), with the following format:
```
type(scope): description
[optional body]
[optional footer]
```
Common types:
- β¨ feat: New features
- π fix: Bug fixes
- π docs: Documentation
- π style: Code style
- β»οΈ refactor: Code refactoring
- β
test: Testing
- π§ chore: Build process or tools
## β FAQ
### Q: How to add new language support?
A: Add translation files in the `messages` directory and configure in `constants/values.ts`.
### Q: How to customize themes?
A: Modify theme configuration in `tailwind.config.ts`.
## π¬ Support
- π Submit Issues
- π§ Contact Maintenance Team
## π License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.