Skip to content

Commit

Permalink
minor CI changes
Browse files Browse the repository at this point in the history
  • Loading branch information
joelhooks committed Nov 20, 2023
1 parent fb62540 commit 8eca162
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 73 deletions.
6 changes: 3 additions & 3 deletions apps/course-builder-web/next.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,17 @@ const config = {
async redirects() {
return [
...subdomains.map((subdomain) => ({
source: "/:path*",
source: '/:path*',
has: [
{
type: "host",
type: 'host',
value: `${subdomain}.coursebuilder.dev`,
},
],
destination: `https://www.coursebuilder.dev/${subdomain}/:path*`,
permanent: false,
})),
];
]
},
}

Expand Down
40 changes: 20 additions & 20 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'

// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: 'Course Builder',
social: {
github: 'https://github.com/joelhooks/course-builder',
},
sidebar: [
{
label: 'Guides',
items: [
// Each item here is one entry in the navigation menu.
{ label: 'Getting Started', link: '/guides/getting-started/' },
],
}
],
}),
],
});
integrations: [
starlight({
title: 'Course Builder',
social: {
github: 'https://github.com/joelhooks/course-builder',
},
sidebar: [
{
label: 'Guides',
items: [
// Each item here is one entry in the navigation menu.
{ label: 'Getting Started', link: '/guides/getting-started/' },
],
},
],
}),
],
})
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
"sharp": "^0.32.5",
"typescript": "^5.2.2"
}
}
}
10 changes: 5 additions & 5 deletions docs/src/content/config.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { defineCollection } from 'astro:content';
import { docsSchema, i18nSchema } from '@astrojs/starlight/schema';
import { docsSchema, i18nSchema } from '@astrojs/starlight/schema'
import { defineCollection } from 'astro:content'

export const collections = {
docs: defineCollection({ schema: docsSchema() }),
i18n: defineCollection({ type: 'data', schema: i18nSchema() }),
};
docs: defineCollection({ schema: docsSchema() }),
i18n: defineCollection({ type: 'data', schema: i18nSchema() }),
}
49 changes: 19 additions & 30 deletions docs/src/content/docs/guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,10 @@ title: Getting Started
description: This will help you create a new Course Builder project.
---

Course Builder is a Turborepo project that includes the website, this docs
site you are reading right now, and the various libraries and packages that
represent the Course Builder platform.
Course Builder is a Turborepo project that includes the website, this docs site you are reading right now, and the
various libraries and packages that represent the Course Builder platform.

:::note
This guide is a work in progress. It will be updated as the project evolves.
:::
:::note This guide is a work in progress. It will be updated as the project evolves. :::

It's non-trivial and these guides are going to make several assumptions:

Expand All @@ -23,35 +20,31 @@ It's non-trivial and these guides are going to make several assumptions:

This is a **lot** of assumptions!

There will be plenty of detail and links, but if you are not familiar with
these technologies, you may want to start with some of the links above.
There will be plenty of detail and links, but if you are not familiar with these technologies, you may want to start
with some of the links above.

## Next.js and the T3 Stack

The Course Builder website is built with [Next.js](https://nextjs.org/). It
uses [`create-t3-app`](https://create.t3.gg/) to scaffold the project. This
provides a consistent opinionated starting point for Next.js projects.
The Course Builder website is built with [Next.js](https://nextjs.org/). It uses
[`create-t3-app`](https://create.t3.gg/) to scaffold the project. This provides a consistent opinionated starting point
for Next.js projects.

- NextAuth
- TailwindCSS
- tRPC
- Drizzle ORM
- CASL

Course Builder is using the Next.js App Router which makes use of React
Server Components.
Course Builder is using the Next.js App Router which makes use of React Server Components.

For the sake of simplicity, Course Builder is deployed to Vercel. This might
not be a strict requirement, but hosting on other platforms is left as an
exercise for the reader.
For the sake of simplicity, Course Builder is deployed to Vercel. This might not be a strict requirement, but hosting on
other platforms is left as an exercise for the reader.

## Integrated Third-Party Services

Course Builder is integrated with several third-party services. These are
all currently required for the project to function. This means that you will
need to create accounts with these services and configure them for your
project by adding the various keys and secrets to your environment variables
in the `course-builder-web` app.
Course Builder is integrated with several third-party services. These are all currently required for the project to
function. This means that you will need to create accounts with these services and configure them for your project by
adding the various keys and secrets to your environment variables in the `course-builder-web` app.

- [Sanity](https://sanity.io): Content management
- [Inngest](https://inngest.com): event-driven workflows
Expand All @@ -62,8 +55,8 @@ in the `course-builder-web` app.
- [Postmark](https://postmarkapp.com): Sending emails
- [OpenAI](https://openai.com/): AI-powered content generation

It's possible to swap these out to suit your needs and preferences, but the
assumption in these guides is that you will be using these services.
It's possible to swap these out to suit your needs and preferences, but the assumption in these guides is that you will
be using these services.

## Clone the Repository

Expand All @@ -86,17 +79,13 @@ cp .env.example .env

They are all required.

:::note
There are 3 (THREE!) different entries for the URL of the project in the
environment:
:::note There are 3 (THREE!) different entries for the URL of the project in the environment:

```dotenv
NEXTAUTH_URL="YOUR_TUNNEL.ngrok-free.app/"
UPLOADTHING_URL="http://localhost:3000"
NEXT_PUBLIC_URL="https://YOUR_TUNNEL.ngrok-free.app/"
```

This is because the project is using several different services that need to
know the URL of the project. This is a bit of a pain, but it's the way it is
for now.
:::
This is because the project is using several different services that need to know the URL of the project. This is a bit
of a pain, but it's the way it is for now. :::
26 changes: 13 additions & 13 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ hero:
icon: external
---

import { Card, CardGrid } from '@astrojs/starlight/components';
import { Card, CardGrid } from '@astrojs/starlight/components'

## Next steps

<CardGrid stagger>
<Card title="Update content" icon="pencil">
Edit `src/content/docs/index.mdx` to see this page change.
</Card>
<Card title="Add new content" icon="add-document">
Add Markdown or MDX files to `src/content/docs` to create new pages.
</Card>
<Card title="Configure your site" icon="setting">
Edit your `sidebar` and other config in `astro.config.mjs`.
</Card>
<Card title="Read the docs" icon="open-book">
Learn more in [the Starlight Docs](https://starlight.astro.build/).
</Card>
<Card title="Update content" icon="pencil">
Edit `src/content/docs/index.mdx` to see this page change.
</Card>
<Card title="Add new content" icon="add-document">
Add Markdown or MDX files to `src/content/docs` to create new pages.
</Card>
<Card title="Configure your site" icon="setting">
Edit your `sidebar` and other config in `astro.config.mjs`.
</Card>
<Card title="Read the docs" icon="open-book">
Learn more in [the Starlight Docs](https://starlight.astro.build/).
</Card>
</CardGrid>
2 changes: 1 addition & 1 deletion docs/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"extends": "astro/tsconfigs/strict"
}
}

1 comment on commit 8eca162

@vercel
Copy link

@vercel vercel bot commented on 8eca162 Nov 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.