Skip to content

steamship-core/steamship-frontend

Repository files navigation

Steamship Frontend

This is an official starter Turborepo.

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

  • python-docs: Our documentation site built with Nextra
  • workshop: A Next.js App integrated with Steamship
  • react-components: A React component library for quickly getting started with Steamship
  • tailwind-config: A preset tailwind configuration
  • eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • tsconfig: tsconfig.jsons used throughout the monorepo

Utilities

This Turborepo has some additional tools already setup for you:

Build

To build all apps and packages, run the following command:

pnpm build

Develop

To develop all apps and packages, run the following command:

pnpm dev

Updating the changelog

To develop all apps and packages, run the following command:

pnpm changeset
pnpm changeset publish --tag {TAG}

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

cd my-turborepo
npx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:

npx turbo link

Useful Links

Learn more about the power of Turborepo:

Publishing

To publish a new version to npm, you'll first need to be authorized. Use npm adduser to login to the npm registry.

pnpm publish-packages