-
-
Notifications
You must be signed in to change notification settings - Fork 400
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Start working on app-level documentation
- Loading branch information
1 parent
74e2a52
commit eb98f10
Showing
14 changed files
with
94 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: API | ||
description: The next-forge API explained | ||
--- | ||
|
||
next-forge exports the API from the `apps/api` directory. It is designed to be run separately from the main app, and is used to run serverless functions e.g. webhooks and cron jobs. | ||
|
||
The API is separated from the web app for two reasons: | ||
|
||
1. To isolate functions that are not part of the main user-facing application i.e. background jobs, cron jobs, webhooks, etc. | ||
2. To provide a dedicated endpoint for non-web applications e.g. mobile apps, smart home devices, etc. | ||
|
||
Functionally speaking, it doesn't matter as much if you're running these projects on Vercel. Serverless functions are all independent pieces of infrastructure and can scale independently. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: App | ||
description: The next-forge main app explained | ||
--- | ||
|
||
next-forge exports the main app from the `apps/app` directory. It is designed to be run on a subdomain of your choice, and is used to run the main user-facing application. | ||
|
||
The main app is built with [shadcn/ui](https://ui.shadcn.com/) and is designed to be a starting point for your own projects. It includes a variety of components, hooks, and utilities to help you get started. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: Email | ||
description: The email of next-forge | ||
--- | ||
|
||
To preview the emails templates, simply run the `email` app: | ||
|
||
```sh Terminal | ||
pnpm dev --filter email | ||
``` |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: Studio | ||
description: The studio of next-forge | ||
--- | ||
|
||
next-forge includes Prisma Studio, which is a visual editor for your database. To start it, run the following command: | ||
|
||
```sh Terminal | ||
pnpm dev --filter studio | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: Web | ||
description: The web of next-forge | ||
--- | ||
|
File renamed without changes.