Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
Signed-off-by: Mihovil Ilakovac <[email protected]>
  • Loading branch information
infomiho committed Nov 14, 2024
1 parent c350cbe commit 69fdbc3
Show file tree
Hide file tree
Showing 14 changed files with 77 additions and 14 deletions.
7 changes: 7 additions & 0 deletions web/docs/deployment/ci-cd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: CI/CD Scenarios
---

TODO: we'll talk about how to e2e test Wasp apps in the CI

TODO: we'll talk about building the server as a Docker image in the CI
11 changes: 11 additions & 0 deletions web/docs/deployment/database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Database
---

TODO: we'll explain the database in the context of deployment

TODO: the only requirement from Wasp's point of view - it has to be a PostgreSQL database accessible from the server via the `DATABASE_URL` environment variable

TODO: we'll talk about migrations: how are they created in development, how are they applied in production, how to debug failed migrations

TODO: we'll talk about how to open the DB studio in development and production
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Deploying with the Wasp CLI
title: Wasp CLI
---

import { Required } from '@site/src/components/Tag';
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Deploying Manually
title: Platform as a Service (PaaS)
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
6 changes: 6 additions & 0 deletions web/docs/deployment/deployment-methods/self-hosted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Self-Hosted
---

TODO: Talk about how to setup Wasp with a plain VPS, Caprover and Coolify

7 changes: 7 additions & 0 deletions web/docs/deployment/env-vars.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Environment Variables
---

TODO: we'll explain env vars in the deployment context - client vs. server env vars, all the required env vars, development vs. production env vars

TODO: deduplicate with the env vars section in the project setup category
9 changes: 9 additions & 0 deletions web/docs/deployment/extras.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Extras
---

TODO: Is Wasp production ready? What are the limitations?

TODO: DDos and CDN recommendations

TODO: Custom domain setup
10 changes: 10 additions & 0 deletions web/docs/deployment/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Introduction
---

TODO: the time to share your app with the world has come

TODO: we'll take you through the process of deploying your app to the web

TODO: first, you'll need to understand the structure of a Wasp app: Node.js backend, React frontend, and a PostgreSQL database. We'll explain the client app, server app and how it connects to the database.

37 changes: 25 additions & 12 deletions web/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,30 @@ module.exports = {
'project/custom-vite-config',
],
},
{
type: 'category',
label: 'Deployment',
collapsed: false,
collapsible: true,
items: [
'deployment/intro',
'deployment/env-vars',
'deployment/database',
{
type: 'category',
label: 'Deployment Methods',
collapsed: true,
items: [
'deployment/deployment-methods/overview',
'deployment/deployment-methods/cli',
'deployment/deployment-methods/paas',
'deployment/deployment-methods/self-hosted',
],
},
'deployment/ci-cd',
'deployment/extras',
],
},
{
type: 'category',
label: 'Wasp AI',
Expand All @@ -119,17 +143,6 @@ module.exports = {
'advanced/links',
],
},
{
type: 'category',
label: 'Deployment',
collapsed: false,
collapsible: true,
items: [
'advanced/deployment/overview',
'advanced/deployment/cli',
'advanced/deployment/manually',
],
},
{
type: 'category',
label: 'General',
Expand All @@ -139,7 +152,7 @@ module.exports = {
'general/language',
'general/cli',
'general/typescript',
'general/wasp-ts-config'
'general/wasp-ts-config',
],
},
{
Expand Down

0 comments on commit 69fdbc3

Please sign in to comment.