Skip to content

Commit ba33632

Browse files
Update README.md (#639)
1 parent 0e093e5 commit ba33632

File tree

1 file changed

+112
-3
lines changed

1 file changed

+112
-3
lines changed

README.md

Lines changed: 112 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,122 @@
1010

1111
## Overview
1212

13-
[next-forge](https://github.com/vercel/next-forge) is a [Next.js](https://nextjs.org/) project boilerplate for modern web application. It is designed to be a comprehensive starting point for new apps, providing a solid, opinionated foundation with a minimal amount of configuration.
13+
[next-forge](https://github.com/vercel/next-forge) is a production-grade [Turborepo](https://turborepo.com) template for [Next.js](https://nextjs.org/) apps. It's designed to be a comprehensive starting point for building SaaS applications, providing a solid, opinionated foundation with minimal configuration required.
14+
15+
Built on a decade of experience building web applications, next-forge balances speed and quality to help you ship thoroughly-built products faster.
16+
17+
### Philosophy
18+
19+
next-forge is built around five core principles:
20+
21+
- **Fast** — Quick to build, run, deploy, and iterate on
22+
- **Cheap** — Free to start with services that scale with you
23+
- **Opinionated** — Integrated tooling designed to work together
24+
- **Modern** — Latest stable features with healthy community support
25+
- **Safe** — End-to-end type safety and robust security posture
26+
27+
## Demo
28+
29+
Experience next-forge in action:
30+
31+
- [Web](https://demo.next-forge.com) — Marketing website
32+
- [App](https://app.demo.next-forge.com) — Main application
33+
- [Storybook](https://storybook.demo.next-forge.com) — Component library
34+
- [API](https://api.demo.next-forge.com/health) — API health check
35+
36+
## Features
37+
38+
next-forge comes with batteries included:
39+
40+
### Apps
41+
42+
- **Web** — Marketing site built with Tailwind CSS and TWBlocks
43+
- **App** — Main application with authentication and database integration
44+
- **API** — RESTful API with health checks and monitoring
45+
- **Docs** — Documentation site powered by Mintlify
46+
- **Email** — Email templates with React Email
47+
- **Storybook** — Component development environment
48+
49+
### Packages
50+
51+
- **Authentication** — Powered by [Clerk](https://clerk.com)
52+
- **Database** — Type-safe ORM with migrations
53+
- **Design System** — Comprehensive component library with dark mode
54+
- **Payments** — Subscription management via [Stripe](https://stripe.com)
55+
- **Email** — Transactional emails via [Resend](https://resend.com)
56+
- **Analytics** — Web ([Google Analytics](https://developers.google.com/analytics)) and product ([Posthog](https://posthog.com))
57+
- **Observability** — Error tracking ([Sentry](https://sentry.io)), logging, and uptime monitoring ([BetterStack](https://betterstack.com))
58+
- **Security** — Application security ([Arcjet](https://arcjet.com)), rate limiting, and secure headers
59+
- **CMS** — Type-safe content management for blogs and documentation
60+
- **SEO** — Metadata management, sitemaps, and JSON-LD
61+
- **AI** — AI integration utilities
62+
- **Webhooks** — Inbound and outbound webhook handling
63+
- **Collaboration** — Real-time features with avatars and live cursors
64+
- **Feature Flags** — Feature flag management
65+
- **Cron** — Scheduled job management
66+
- **Storage** — File upload and management
67+
- **Internationalization** — Multi-language support
68+
- **Notifications** — In-app notification system
1469

1570
## Getting Started
1671

17-
Clone the repo using:
72+
### Prerequisites
73+
74+
- Node.js 20+
75+
- [pnpm](https://pnpm.io) (or npm/yarn/bun)
76+
- [Stripe CLI](https://docs.stripe.com/stripe-cli) for local webhook testing
77+
78+
### Installation
79+
80+
Create a new next-forge project:
1881

1982
```sh
2083
npx next-forge@latest init
2184
```
2285

23-
Then read the [docs](https://www.next-forge.com/docs) for more information.
86+
### Setup
87+
88+
1. Configure your environment variables
89+
2. Set up required service accounts (Clerk, Stripe, Resend, etc.)
90+
3. Run the development server
91+
92+
For detailed setup instructions, read the [documentation](https://www.next-forge.com/docs).
93+
94+
## Structure
95+
96+
next-forge uses a monorepo structure managed by Turborepo:
97+
98+
```
99+
next-forge/
100+
├── apps/ # Deployable applications
101+
│ ├── web/ # Marketing website (port 3001)
102+
│ ├── app/ # Main application (port 3000)
103+
│ ├── api/ # API server
104+
│ ├── docs/ # Documentation
105+
│ ├── email/ # Email templates
106+
│ └── storybook/ # Component library
107+
└── packages/ # Shared packages
108+
├── design-system/
109+
├── database/
110+
├── auth/
111+
└── ...
112+
```
113+
114+
Each app is self-contained and independently deployable. Packages are shared across apps for consistency and maintainability.
115+
116+
## Documentation
117+
118+
Full documentation is available at [next-forge.com/docs](https://www.next-forge.com/docs), including:
119+
120+
- Detailed setup guides
121+
- Package documentation
122+
- Migration guides for swapping providers
123+
- Deployment instructions
124+
- Examples and recipes
125+
126+
## Contributing
127+
128+
We welcome contributions! See the [contributing guide](https://github.com/vercel/next-forge/blob/main/.github/CONTRIBUTING.md) for details.
24129

25130
## Contributors
26131

@@ -29,3 +134,7 @@ Then read the [docs](https://www.next-forge.com/docs) for more information.
29134
</a>
30135

31136
Made with [contrib.rocks](https://contrib.rocks).
137+
138+
## License
139+
140+
MIT

0 commit comments

Comments
 (0)