From ef321c3ff884a060a529003d6253ae53fc7b3d8f Mon Sep 17 00:00:00 2001 From: konrad-enlaye Date: Fri, 5 Dec 2025 12:57:20 -0500 Subject: [PATCH] update readme --- README.md | 41 +++++++++++++---------------------------- 1 file changed, 13 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index e215bc4..6f16348 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,21 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). +# Enlaye Files + +This is a [Next.js](https://nextjs.org) project, with Drizzle and a local file-based SQL database. ## Getting Started -First, run the development server: +Use `npm` or `pnpm` (this project's default) or `yarn`. ```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev +pnpm install +pnpm run db:push # to create the database and update it + +# Then you can run these two background tasks +pnpm run dev +pnpm run db:studio ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +## Troubleshooting -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. +- `pnpm run db:push` is necessary at the beginning, and whenever `schema.ts` is updated. +- whenever something is wrong with the database, delete [`sqlite.db`](./sqlite.db) to clear the database, and restart the app.