Skip to content

Commit

Permalink
More images
Browse files Browse the repository at this point in the history
  • Loading branch information
haydenbleasel committed Dec 11, 2024
1 parent 197d15d commit b6ddc0d
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/deployment/netlify.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: Deploying to Netlify
description: How to deploy next-forge to Netlify
---

<Frame>
<img src="/images/deployment/netlify.png" alt="" />
</Frame>

To deploy next-forge on Netlify, you need to create 3 new projects for the `app`, `api` and `web` apps. After selecting your repository, change the "Site to deploy" selection to the app of choice e.g. `apps/app`. This should automatically detect the Next.js setup and as such, the build command and output directory.

Then, add all your environment variables to the project.
Expand Down
4 changes: 4 additions & 0 deletions docs/deployment/vercel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ import { VercelButton } from '/snippets/vercel.mdx';
},
}]} />

<Frame>
<img src="/images/deployment/vercel.png" alt="" />
</Frame>

To deploy next-forge on Vercel, you need to create 3 new projects for the `app`, `api` and `web` apps. After selecting your repository, change the Root Directory option to the app of choice e.g. `apps/app`. This should automatically detect the Next.js setup and as such, the build command and output directory.

Then, add all your environment variables to the project.
Expand Down
4 changes: 4 additions & 0 deletions docs/features/testing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: Testing
description: How we've configured testing in next-forge.
---

<Frame>
<img src="/images/testing.png" alt="" />
</Frame>

next-forge uses [Vitest](https://vitest.dev/) for unit testing. It's a fast and lightweight testing framework that's compatible with Jest's API. Unit tests are run automatically as part of the `build` task in Turborepo.

## Running Tests
Expand Down
Binary file added docs/images/deployment/netlify.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/deployment/vercel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/structure/apps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/structure/packages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/testing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/structure/apps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: Apps
description: The apps of next-forge
---

<Frame>
<img src="/images/structure/apps.png" alt="" />
</Frame>

next-forge is a monorepo, which means it contains multiple packages in a single repository. This is a common pattern for modern web applications, as it allows you to share code between different parts of the application, and manage them all together.

The monorepo is managed by [Turborepo](https://turbo.build/repo), which is a tool for managing monorepos. It provides a simple way to manage multiple packages in a single repository, and is designed to work with modern web applications.
Expand Down
4 changes: 4 additions & 0 deletions docs/structure/packages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: Packages
description: The packages of next-forge
---

<Frame>
<img src="/images/structure/packages.png" alt="" />
</Frame>

next-forge contains a number of shared packages that are used across the monorepo. The purpose of these packages is to isolate shared code from the main app, making it easier to manage and update.

Additionally, it makes it easier to swap out parts of the app for different implementations. For example, the `database` package contains everything related to the database, including the schema and migrations. This allows us to easily swap out the database provider or ORM without impacting other parts of the app.
Expand Down

0 comments on commit b6ddc0d

Please sign in to comment.