Skip to content

A template for running slash-create on a Next.js server.

Notifications You must be signed in to change notification settings

RocketDragon/slash-create-nextjs-template

Repository files navigation

This is a Next.js project bootstrapped with create-next-app.

Specific details about this 'template'

This is by no means official nor is it to be considered a 'best practice' for Next.js or slash-create. That said, it works well enough to get you on your way.

Much of this has been derived from the vercel template which follows a similar architecture.

When you're ready to start the service, register the interactions url as /api/interactions. (Include whatever comes before it in the url, if you have any - domain, port, etc.)

For help with slash-create please join Snazzah's hangout, otherwise please visit TinkerStorm or open an issue - anything to do with this template specifically.

Important files

  • The base server structure is called from /api/interactions, but is calling the endpoint from ./util/ServerBase.js so to remain consistent with the library's infrastructure (and how it handles external imports).
  • The commands folder is located outside of the pages folder at project root to ensure that it can be imported without the extrenuous need to write out a path to it.

Note: This is a bit of a hack, but it's a good way to keep the commands folder out of the pages folder. The same was attempted for TypeScript, but the problem was that this TypeScript compiler configuration was not able to include the file in the build process.

Everything else remains unchanged.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

About

A template for running slash-create on a Next.js server.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published