Rename project to Brachnha Insights
- Updated package.json name field - Created proper README with project description - Updated BMAD configuration Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
50
README.md
50
README.md
@@ -1,8 +1,29 @@
|
||||
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).
|
||||
# Brachnha Insights
|
||||
|
||||
A modern journaling and self-reflection application powered by AI.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Framework:** Next.js 14+ (App Router)
|
||||
- **Language:** TypeScript (Strict Mode)
|
||||
- **Styling:** Tailwind CSS, ShadCN UI
|
||||
- **State Management:** Zustand v5
|
||||
- **Database:** Dexie.js (IndexedDB) - Local-first architecture
|
||||
- **Auth:** Auth.js v5
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
First, install dependencies:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
# or
|
||||
yarn install
|
||||
# or
|
||||
pnpm install
|
||||
```
|
||||
|
||||
Then, run the development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
@@ -10,27 +31,22 @@ npm run dev
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
## Features
|
||||
|
||||
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.
|
||||
- AI-powered journaling and reflection
|
||||
- Local-first data storage (your data stays on your device)
|
||||
- Offline support
|
||||
- Beautiful, responsive design
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
To learn more about the technologies used:
|
||||
|
||||
- [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.
|
||||
- [Next.js Documentation](https://nextjs.org/docs)
|
||||
- [Tailwind CSS](https://tailwindcss.com)
|
||||
- [ShadCN UI](https://ui.shadcn.com)
|
||||
- [Zustand](https://zustand-demo.pmnd.rs)
|
||||
|
||||
Reference in New Issue
Block a user