Skip to content

Latest commit

 

History

History
116 lines (73 loc) · 3.68 KB

CONTRIBUTING.md

File metadata and controls

116 lines (73 loc) · 3.68 KB
Raw

next-admin

What's inside?

An auto generated admin from Prisma models for your Next.js app.

Apps and Packages

  • apps/docs: a Next.js app
  • apps/example: a Next.js app that uses the next-admin package
  • packages/next-admin: the admin library used by both web and docs applications
  • packages/cli: a CLI to generate the admin in your Next.js app
  • packages/generator-prisma: a CLI to generate a json schema of your Prisma models
  • packages/json-schema: a packages to normalize the Prisma schema to a json schema (primarily used to type the generated and next-admin packages)
  • packages/eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • packagestsconfig: tsconfig.jsons used throughout the monorepo

Utilities

This turborepo has some additional tools already setup for you:

Setup

To setup the project, run the following command:

pnpm install

Then you need to create a .env file in the apps/example project with the following content:

DATABASE_URL="postgresql://user:password@localhost:5432/dbname"

And run the following command to setup the packages:

pnpm setup:packages

The setup:packages command will build packages, generate Prisma and then build next-admin package.

Prisma (first time setup)

To setup the database, run the following command:

pnpm database

Develop

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

pnpm dev
docker-compose up
cd apps/example && pnpm database

Build

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

pnpm build

Workflow

The project workflow uses GitHub Actions to run tests, build, deploy (prod - preview - docs) and publish packages. To handle versioning up and publishing, we use Changesets

Create a changeset file

To increase the version of a package, you need to create a changeset file. You can create a changeset file by running the following command:

pnpm changeset

Any PR without a changeset file will just trigger the tests and eventually deploy/preview the app.

Current major release features

If you want to contribute on the current major version, you can create a PR on the main branch. Any merged PR on the main branch that contains changeset files will create a PR changeset-release/main, which we could merge into main to release a new version.

Note: Make sure that the branch was created and updated from the main branch.

schema

Fixing an old major release

If you want to fix a previous major version, you can create a PR on the relative branch (fix v1 on branch v1). Any merged PR on those branches that contains changeset files will create a PR changeset-release/[v1|v2|v3], which we could merge into [v1|v2|v3] to release a new version.

Note: Make sure that the branch was created from the latest release of the major version you want to fix.

schema-fix

Once a fix has been released, you can cherry-pick the fix on the develop branch if that fix is still relevant.

E2E

Tests are using Playwright to test directly with a browser.

You can write and debug tests easily with this commande

cd apps/example
npx playwright install
npx playwright test --ui