Skip to content

Commit

Permalink
update docs, remove schema in cli templates
Browse files Browse the repository at this point in the history
  • Loading branch information
foyarash committed Oct 2, 2024
1 parent c982f2d commit 71f9cf6
Show file tree
Hide file tree
Showing 7 changed files with 5 additions and 30 deletions.
19 changes: 5 additions & 14 deletions apps/docs/pages/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,18 @@ npx @premieroctet/next-admin-cli@latest init --help
<Tabs items={["yarn", "npm", "pnpm"]}>
<Tabs.Tab>
```bash copy
yarn add @premieroctet/next-admin prisma-json-schema-generator
yarn add @premieroctet/next-admin @premieroctet/next-admin-generator-prisma
```

</Tabs.Tab>
<Tabs.Tab>
```bash copy
npm install -S @premieroctet/next-admin prisma-json-schema-generator
npm install -S @premieroctet/next-admin @premieroctet/next-admin-generator-prisma
```
</Tabs.Tab>
<Tabs.Tab>
```bash copy
pnpm install -S @premieroctet/next-admin prisma-json-schema-generator
pnpm install -S @premieroctet/next-admin @premieroctet/next-admin-generator-prisma
```
</Tabs.Tab>
</Tabs>
Expand Down Expand Up @@ -80,9 +80,8 @@ Next-Admin relies on [Prisma](https://www.prisma.io/) for the database. If you d
You have to add the `jsonSchema` generator to your `schema.prisma` file:

```prisma copy filename="schema.prisma"
generator jsonSchema {
provider = "prisma-json-schema-generator"
includeRequiredFields = "true"
generator nextAdmin {
provider = "next-admin-generator-prisma"
}
```

Expand All @@ -105,7 +104,6 @@ Next-Admin uses a dynamic route `[[...nextadmin]]` to handle all the admin route
import { NextAdmin, PageProps } from "@premieroctet/next-admin";
import { getNextAdminProps } from "@premieroctet/next-admin/appRouter";
import { prisma } from "@/prisma";
import schema from "@/prisma/json-schema/json-schema.json";
import "@/styles.css" // .css file containing tailiwnd rules
export default async function AdminPage({
Expand All @@ -118,7 +116,6 @@ Next-Admin uses a dynamic route `[[...nextadmin]]` to handle all the admin route
basePath: "/admin",
apiBasePath: "/api/admin",
prisma,
schema,
/*options*/
});

Expand Down Expand Up @@ -149,7 +146,6 @@ Next-Admin uses a dynamic route `[[...nextadmin]]` to handle all the admin route
import { getNextAdminProps } from "@premieroctet/next-admin/pageRouter";
import { GetServerSideProps } from "next";
import { prisma } from " @/prisma";
import schema from "@/prisma/json-schema/json-schema.json";

export default function Admin(props: AdminComponentProps) {
return (
Expand All @@ -165,7 +161,6 @@ Next-Admin uses a dynamic route `[[...nextadmin]]` to handle all the admin route
basePath: "/pagerouter/admin",
apiBasePath: "/api/pagerouter/admin",
prisma,
schema,
/*options*/
req,
});
Expand Down Expand Up @@ -266,13 +261,11 @@ Next-Admin uses a dynamic route `[[...nextadmin]]` to handle all the API routes.

```ts copy filename="app/api/admin/[[...nextadmin]]/route.ts"
import { prisma } from "@/prisma";
import schema from "@/prisma/json-schema/json-schema.json";
import { createHandler } from "@premieroctet/next-admin/appHandler";

const { run } = createHandler({
apiBasePath: "/api/admin",
prisma,
schema,
/*options*/
});

Expand All @@ -285,7 +278,6 @@ Next-Admin uses a dynamic route `[[...nextadmin]]` to handle all the API routes.
```ts copy filename="pages/api/admin/[[...nextadmin]].ts"
import { prisma } from "@/prisma";
import { createHandler } from "@premieroctet/next-admin/pageHandler";
import schema from "@/prisma/json-schema/json-schema.json";

export const config = {
api: {
Expand All @@ -296,7 +288,6 @@ Next-Admin uses a dynamic route `[[...nextadmin]]` to handle all the API routes.
const { run } = createHandler({
apiBasePath: "/api/admin",
prisma,
schema: schema,
/*options*/,
});

Expand Down
1 change: 0 additions & 1 deletion apps/example/app/api/admin/[[...nextadmin]]/route.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { options } from "@/options";
import { prisma } from "@/prisma";
import schema from "@/prisma/json-schema/json-schema.json";
import { createHandler } from "@premieroctet/next-admin/appHandler";

const { run } = createHandler({
Expand Down
7 changes: 0 additions & 7 deletions packages/cli/src/commands/init.ts
Original file line number Diff line number Diff line change
Expand Up @@ -190,17 +190,11 @@ export const initAction = async ({
basePath,
prismaClientPath.replace(/\.(ts|tsx|js|jsx)$/, "")
);
const jsonSchemaPath = path.join(
path.dirname(schemaPath),
"json-schema",
"json-schema.json"
);

const pageContent = writeToTemplate(
routerRootPath.type === "page" ? "page_router_page" : "app_router_page",
{
prismaClientPath: getRelativePath(pageFilePath, prismaPath),
jsonSchemaPath: getRelativePath(pageFilePath, jsonSchemaPath),
stylesPath: getRelativePath(
pageFilePath,
path.join(basePath, NEXTADMIN_CSS_FILENAME)
Expand All @@ -221,7 +215,6 @@ export const initAction = async ({
routerRootPath.type === "page" ? "page_router_api" : "app_router_api",
{
prismaClientPath: getRelativePath(apiFilePath, prismaPath),
jsonSchemaPath: getRelativePath(apiFilePath, jsonSchemaPath),
optionsPath: getRelativePath(
apiFilePath,
path.join(basePath, NEXTADMIN_OPTIONS_FILENAME)
Expand Down
2 changes: 0 additions & 2 deletions packages/cli/src/templates/app_router_api.mustache
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
import prisma from "{{prismaClientPath}}";
import schema from "{{jsonSchemaPath}}";
import { createHandler } from "@premieroctet/next-admin/appHandler";
import options from "{{optionsPath}}";

const { run } = createHandler({
apiBasePath: "{{apiBasePath}}",
prisma,
schema,
options
});

Expand Down
2 changes: 0 additions & 2 deletions packages/cli/src/templates/app_router_page.mustache
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { NextAdmin{{#isTypescript}}, PageProps{{/isTypescript}} } from "@premieroctet/next-admin";
import { getNextAdminProps } from "@premieroctet/next-admin/appRouter";
import prisma from "{{prismaClientPath}}";
import schema from "{{jsonSchemaPath}}";
import "{{stylesPath}}";
import options from "{{optionsPath}}";

Expand All @@ -15,7 +14,6 @@ export default async function AdminPage({
basePath: "{{pageBasePath}}",
apiBasePath: "{{apiBasePath}}",
prisma,
schema,
options
});

Expand Down
2 changes: 0 additions & 2 deletions packages/cli/src/templates/page_router_api.mustache
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import prisma from "{{prismaClientPath}}";
import schema from "{{jsonSchemaPath}}";
import { createHandler } from "@premieroctet/next-admin/pageHandler";
import options from "{{optionsPath}}";

Expand All @@ -12,7 +11,6 @@ export const config = {
const { run } = createHandler({
apiBasePath: "{{apiBasePath}}",
prisma,
schema,
options,
});

Expand Down
2 changes: 0 additions & 2 deletions packages/cli/src/templates/page_router_page.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import { {{#isTypescript}} AdminComponentProps,{{/isTypescript}} NextAdmin } fro
import { getNextAdminProps } from "@premieroctet/next-admin/pageRouter";
{{#isTypescript}}import { GetServerSideProps } from "next";{{/isTypescript}}
import prisma from "{{prismaClientPath}}";
import schema from "{{jsonSchemaPath}}";
import options from "{{optionsPath}}";

export default function Admin(props{{#isTypescript}}: AdminComponentProps{{/isTypescript}}) {
Expand All @@ -19,7 +18,6 @@ export const getServerSideProps{{#isTypescript}}: GetServerSideProps{{/isTypescr
basePath: "{{pageBasePath}}",
apiBasePath: "{{apiBasePath}}",
prisma,
schema,
options,
req,
});

0 comments on commit 71f9cf6

Please sign in to comment.