Skip to content

Commit

Permalink
docs: update project guidelines to remove TanStack Router from routin…
Browse files Browse the repository at this point in the history
…g organization rules (#19)
  • Loading branch information
BramSuurdje authored Nov 25, 2024
1 parent ae935a6 commit f2ca534
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .cursorrules
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Project-specific rules:
- Store set classes in `/src/lib/classes/`.
- Use TypeScript for all files.
- Use ShadCN for UI components.
- Organize routes using the App Router and TanStack Router.
- Organize routes using the App Router.

Database:
- Use PostgreSQL for the database.
Expand Down
36 changes: 24 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
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).
🚀 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).

## Getting Started
## 🚧 Getting Started

First, run the development server:

Expand All @@ -16,24 +16,36 @@ 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.

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
## 🤔 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!
## 🚀 Extra Libraries used

## Extra Libraries used

- [@tanstack/react-query](https://tanstack.com/query/v5) - Fetching data
- [@tanstack/react-query](https://tanstack.com/query/v5) - Fetching data on the client
- [zod](https://zod.dev/) - Validation
- [ShadCN](https://shadcn.com/) - UI components

## 🚧 Commit Message Guidelines

This project follows a specific commit message format. Please use one of the following types:

- `ci`: Changes to CI configuration files and scripts
- `chore`: Maintenance tasks, such as updating dependencies or fixing code style
- `docs`: Changes to documentation
- `ticket`: Changes related to a specific ticket or issue
- `feat`: New features or functionality
- `fix`: Bug fixes
- `perf`: Performance improvements
- `refactor`: Code refactoring
- `revert`: Reverting previous changes
- `style`: Changes to code style or formatting

you wont be able to commit without a type, so make sure to add one.

## Quirks
## 🚨 Quirks

- To add new env variables, add them to the `.env.example` file and head over to `@/lib/env.ts` to add them to the `EnvSchema`. this will allow you to access them in your app in a type-safe manner.
Empty file added src/utils/api.ts
Empty file.

0 comments on commit f2ca534

Please sign in to comment.