create-roadkit
Version:
Beautiful Next.js roadmap website generator with full-screen kanban boards, dark/light mode, and static export
111 lines (76 loc) ⢠2.19 kB
Markdown
# {{projectName}}
{{description}}
## Overview
This is a Next.js roadmap website generated by RoadKit. It provides a clean, modern interface for displaying project timelines and roadmaps.
### Features
- š± Responsive design
- šØ Modern UI with Tailwind CSS
- ā” Built with Next.js 14
- š§ TypeScript support
- šÆ SEO optimized
- š Ready for deployment
## Getting Started
### Prerequisites
- Node.js 18+ or Bun
- npm, yarn, pnpm, or bun
### Installation
1. Install dependencies:
```bash
bun install
# or
npm install
```
2. Copy environment variables:
```bash
cp .env.example .env.local
```
3. Configure your environment variables in `.env.local`
4. Start the development server:
```bash
bun dev
# or
npm run dev
```
5. Open [http://localhost:3000](http://localhost:3000) in your browser
## Project Structure
```
{{projectName}}/
āāā src/
ā āāā app/
ā ā āāā layout.tsx # Root layout
ā ā āāā page.tsx # Home page
ā ā āāā globals.css # Global styles
ā āāā components/ # Reusable components
āāā public/ # Static assets
āāā README.md
āāā package.json
āāā next.config.js
```
## Customization
### Colors
Update your brand colors in:
- `src/app/globals.css` - CSS custom properties
- `tailwind.config.js` - Tailwind theme colors
### Content
- Modify the roadmap content in `src/app/page.tsx`
- Add new pages in the `src/app/` directory
- Create reusable components in `src/components/`
## Deployment
This project is ready to deploy on:
- [Vercel](https://vercel.com) (recommended)
- [Netlify](https://netlify.com)
- [Railway](https://railway.app)
### Deploy on Vercel
```bash
npm install -g vercel
vercel
```
## Built With
- [Next.js](https://nextjs.org) - React framework
- [Tailwind CSS](https://tailwindcss.com) - Utility-first CSS
- [TypeScript](https://typescriptlang.org) - Type safety
## Author
**{{author.name}}**{{#author.email}} - {{author.email}}{{/author.email}}{{#author.url}}
- Website: {{author.url}}{{/author.url}}
## Generated
Created with [RoadKit](https://github.com/your-repo/roadkit) on {{timestamp}}