GithubHelp home page GithubHelp logo

acme-docs's Introduction

Turbo Packages

Deploy on Zeabur

A starter monorepo built with Turborepo, Nextjs, Docker, Typescript, Vitest and Tailwind.

What's included

This turborepo uses pnpm as a package manager. It includes the following packages:

Packages

  • @acme/ui: A UI library built with React, Typescript, Tailwind and Vitest.
  • @acme/ui-utils: A utility library built with Typescript and React.
  • @acme/utils: A utility library built with Typescript.
  • @acme/tailwind-config: A Tailwind config library.

Apps

  • @acme/docs: A documentation app built with Nextra.

Playgrounds

  • next-app-play: A Nextjs app playground.

Getting started

Install dependencies

pnpm i

Run the docs app

pnpm dev --filter docs...

Run the nextjs app

pnpm dev --filter next-app-play...

Build the docs app

pnpm build --filter docs...

Continuous Integration

Test, Lint and Typecheck

pnpm test lint type:check

Check package versions

The repo uses manypkg

manypkg check

manypkg check runs all of the checks against your repo, logs any errors and exits with a code

manypkg fix

manypkg fix runs all of the checks against your repo and fixes any of problems that can be fixed.

pnpm manypkg check

# or

pnpm manypkg fix

Release

The repo uses changesets

Versioning and publishing

Once you decide you want to do a release, you can run

pnpm version

This consumes all changesets, and updates to the most appropriate semver version based on those changesets. It also writes changelog entries for each consumed changeset.

We recommend at this step reviewing both the changelog entries and the version changes for packages. Once you are confident that these are correct, and have made any necessary tweaks to changelogs, you can publish your packages:

pnpm release

This will run npm publish in each package that is of a later version than the one currently listed on npm.

acme-docs's People

Contributors

chia1104 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.