chore: wip

Author: chrisbbreuer

.github/CONTRIBUTING.md

@@ -1,5 +1,7 @@
 # Contributing
 
+WIP: Updates to here are in progress.
+
 First off, thank you for taking the time to contribute to the Stacks ecosystem ❤️
 
 > **Note**

.stacks/core/cloud/src/cloud.ts

@@ -22,7 +22,7 @@ import { app, cloud } from '@stacksjs/config'
 
 export class StacksCloud extends Stack {
   domain: string
-  apiDomain: string
+  apiPath: string
   docsDomain: string
   apiVanityUrl?: string
   vanityUrl: string
@@ -48,7 +48,7 @@ export class StacksCloud extends Stack {
       throw new Error('Your ./config app.url needs to be defined in order to deploy. You may need to adjust the APP_URL inside your .env file.')
 
     this.domain = app.url
-    this.apiDomain = `${app.url}/api`
+    this.apiPath = 'api'
     this.docsDomain = app.docMode ? app.url : `${app.url}/docs`
     this.docsSource = '../../../storage/framework/docs'
     this.websiteSource = app.docMode ? this.docsSource : '../../../storage/public'
@@ -319,8 +319,9 @@ export class StacksCloud extends Stack {
 
       behaviorOptions = {
         '/api/*': {
-          origin: new origins.HttpOrigin(this.apiDomain, {
-            originPath: '/',
+          origin: new origins.HttpOrigin(this.domain, {
+            originPath: '/api',
+            protocolPolicy: cloudfront.OriginProtocolPolicy.HTTPS_ONLY,
           }),
           compress: true,
           allowedMethods: cloudfront.AllowedMethods.ALLOW_ALL,
@@ -337,6 +338,7 @@ export class StacksCloud extends Stack {
         '/docs/*': {
           origin: new origins.S3Origin(this.storage.publicBucket, {
             originAccessIdentity: this.originAccessIdentity,
+            originPath: '/docs',
           }),
           compress: true,
           allowedMethods: this.allowedMethodsFromString(cloud.cdn?.allowedMethods),
@@ -364,7 +366,7 @@ export class StacksCloud extends Stack {
     })
 
     new Output(this, 'ApiUrl', {
-      value: `https://${this.apiDomain}`,
+      value: `https://${this.domain}/${this.apiPath}`,
       description: 'The URL of the deployed application',
     })
 

.stacks/core/env/src/index.ts

@@ -9,6 +9,7 @@ export interface Env {
   APP_URL: string
   APP_DEBUG: boolean
   APP_BUCKET: string
+  API_PATH: string
 
   DB_CONNECTION: string
   DB_HOST: string

.stacks/core/types/src/api.ts

@@ -0,0 +1,24 @@
+/**
+ * **API Options**
+ *
+ * This configuration defines all of your API options. Because Stacks is fully-typed, you
+ * may hover any of the options below and the definitions will be provided. In case you
+ * have any questions, feel free to reach out via Discord or GitHub Discussions.
+ */
+export interface ApiOptions {
+  /**
+   * **API Path**
+   *
+   * This is the path that will be used for all API routes. For example, if you set this
+   * to `api`, then your routes will be `/api/user`, `/api/posts`, etc.
+   *
+   * @default string "api"
+   * @example string "api"
+   * @example string "api/v1"
+   * @example string "api/v2/"
+   * @example string "/api/v2"
+   */
+  path: string
+}
+
+export type ApiConfig = Partial<ApiOptions>

.stacks/core/types/src/index.ts

@@ -1,3 +1,4 @@
+export * from './api'
 export * from './app'
 export * from './auto-imports'
 export * from './binary'

config/api.ts

@@ -0,0 +1,13 @@
+import type { ApiConfig } from '@stacksjs/types'
+import { env } from '@stacksjs/env'
+
+/**
+ * **API Configuration**
+ *
+ * This configuration defines all of your API options. Because Stacks is fully-typed, you
+ * may hover any of the options below and the definitions will be provided. In case you
+ * have any questions, feel free to reach out via Discord or GitHub Discussions.
+ */
+export default {
+  path: env.API_PATH || '/api',
+} satisfies ApiConfig

config/docs.ts

@@ -16,31 +16,23 @@ const nav = [
         items: [
           {
             text: 'Twitter',
-            link: 'https://twitter.com/vite_js',
+            link: 'https://twitter.com/stacksjs',
           },
           {
             text: 'Discord Chat',
-            link: 'https://chat.vitejs.dev',
+            link: 'https://discord.gg/stacksjs',
           },
           {
-            text: 'Awesome Vite',
-            link: 'https://github.com/vitejs/awesome-vite',
-          },
-          {
-            text: 'DEV Community',
-            link: 'https://dev.to/t/vite',
-          },
-          {
-            text: 'Rollup Plugins Compat',
-            link: 'https://vite-rollup-plugins.patak.dev/',
+            text: 'Awesome Stacks',
+            link: 'https://github.com/stacksjs/awesome-stacks',
           },
           {
             text: 'Changelog',
-            link: 'https://github.com/vitejs/vite/blob/main/packages/vite/CHANGELOG.md',
+            link: 'https://github.com/stacksjs/stacks/blob/main/CHANGELOG.md',
           },
           {
             text: 'Contributing',
-            link: 'https://github.com/vitejs/vite/blob/main/CONTRIBUTING.md',
+            link: 'https://github.com/stacksjs/stacks/blob/main/.github/CONTRIBUTING.md',
           },
         ],
       },

docs/index.md

@@ -6,7 +6,7 @@ titleTemplate: Modern TypeScript Fullstack Development.
 
 hero:
   name: Stacks
-  text: Build. Ship. Faster.
+  text: Build. Ship. Faster
   tagline: Rapid application, cloud & library development framework. For the best full-stack teams.
   actions:
     - theme: brand