| public | ||
| src | ||
| .gitignore | ||
| components.json | ||
| CORRECTED_AI_INTEGRATION.md | ||
| eslint.config.mjs | ||
| FRONTEND_AI_INTEGRATION.md | ||
| Jenkinsfile | ||
| next.config.ts | ||
| package-lock.json | ||
| package.json | ||
| postcss.config.mjs | ||
| README.md | ||
| tsconfig.json | ||
CodeNuk Frontend
A modern web application built with Next.js 14, TypeScript, and shadcn/ui. This project serves as the frontend for the CodeNuk platform, providing a user interface for generating and managing code projects.
🚀 Features
- Project Generation: Create new projects with various templates
- Authentication: Secure user authentication flows
- UI Components: Built with shadcn/ui for a consistent design system
- Responsive Design: Works on all device sizes
- Modern Stack: Next.js 14, TypeScript, and Tailwind CSS
🛠️ Prerequisites
- Node.js 18.0.0 or later
- npm or yarn package manager
- Git
🚀 Getting Started
1. Clone the repository
git clone https://github.com/your-username/codenuk-frontend.git
cd codenuk-frontend
2. Install Dependencies
npm install
# or
yarn install
# or
pnpm install
3. Environment Setup
Create a .env.local file in the root directory and add the necessary environment variables:
NEXT_PUBLIC_API_URL=your_api_url_here
NEXT_PUBLIC_APP_URL=http://localhost:3000
# Add other environment variables as needed
4. Run the Development Server
npm run dev
# or
yarn dev
# or
pnpm dev
Open http://localhost:3000 in your browser to see the application running.
🎨 Adding shadcn/ui Components
This project uses shadcn/ui for UI components. Here's how to add new components:
-
Install the shadcn CLI:
npx shadcn-ui@latest init -
Add a new component:
npx shadcn-ui@latest add button -
Import and use the component in your code:
import { Button } from "@/components/ui/button" export function MyComponent() { return <Button>Click me</Button> }
📁 Project Structure
src/
├── app/ # App router
│ ├── auth/ # Authentication pages
│ ├── components/ # Page-specific components
│ ├── layout.tsx # Root layout
│ └── page.tsx # Home page
├── components/ # Reusable components
│ ├── ui/ # shadcn/ui components
│ └── ...
├── lib/ # Utility functions
└── styles/ # Global styles
🧪 Testing
Run the test suite:
npm run test
# or
yarn test
🏗️ Building for Production
-
Build the application:
npm run build -
Start the production server:
npm run start
🤝 Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgments
Made with ❤️ by Tech4Biz
Learn More
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
Deploy on Vercel
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.