taxonomy/README.md

89 lines
2.8 KiB
Markdown
Raw Permalink Normal View History

2022-10-26 13:32:08 +00:00
# Taxonomy
2022-10-26 13:18:06 +00:00
2022-10-26 13:32:08 +00:00
An open source application built using the new router, server components and everything new in Next.js 13.
> **Warning**
2022-11-08 04:56:05 +00:00
> This app is a work in progress. I'm building this in public. You can follow the progress on Twitter [@shadcn](https://twitter.com/shadcn).
2022-10-26 13:32:08 +00:00
> See the roadmap below.
2022-10-26 13:18:06 +00:00
## Demo
2022-10-26 13:32:08 +00:00
![screenshot-2](https://user-images.githubusercontent.com/124599/198038921-2b16b18b-cb4d-44b1-bd1d-6419d4a8d92c.png)
2022-11-02 10:54:19 +00:00
## About this project
Right now, I'm using this project as an experiment to see how a modern app (with features like authentication, subscriptions, API routes, static pages for docs ...etc) would work in Next.js 13 and server components.
I'll be posting updates and issues here.
A few people have asked me to turn this into a starter. I think we could do that once the new features are out of beta.
2022-11-22 15:06:57 +00:00
## Note on Performance
> **Warning**
> This app is using the canary releases for Next.js 13 and React 18. The new router and app dir is still in beta and not production-ready.
> NextAuth.js, which is used for authentication, is also not fully supported in Next.js 13 and RSC.
> **Expect some performance hits when testing the dashboard**.
> If you see something broken, you can ping me [@shadcn](https://twitter.com/shadcn).
2022-10-26 13:18:06 +00:00
## Features
- New `/app` dir,
2022-11-21 14:33:07 +00:00
- Routing, Layouts, Nested Layouts and Layout Groups
- Data Fetching, Caching and Mutation
- Loading UI
- Server and Client Components
- API Routes and Middlewares
- Authentication using **NextAuth.js**
- ORM using **Prisma**
- Database on **PlanetScale**
- UI Components built using **Radix UI**
2022-11-21 14:13:40 +00:00
- Documentation and blog using **MDX** and **Contentlayer**
- Subscriptions using **Stripe**
2022-11-21 14:33:07 +00:00
- Styled using **Tailwind CSS**
- Validations using **Zod**
- Written in **TypeScript**
2022-10-26 13:18:06 +00:00
## Roadmap
2022-11-21 14:33:07 +00:00
- [x] ~Add MDX support for basic pages~
- [x] ~Build marketing pages~
- [x] ~Subscriptions using Stripe~
2022-11-22 08:59:42 +00:00
- [x] ~Responsive styles~
2022-11-21 14:33:07 +00:00
- [ ] Add OG image for blog using @vercel/og
- [ ] Dark mode
2022-10-26 13:18:06 +00:00
2022-10-26 13:32:08 +00:00
## Known Issues
2022-10-26 13:18:06 +00:00
2022-10-26 13:32:08 +00:00
A list of things not working right now:
2022-10-26 13:18:06 +00:00
2022-11-07 09:19:47 +00:00
1. ~GitHub authentication (use email)~
2022-11-21 14:13:40 +00:00
2. ~[Prisma: Error: ENOENT: no such file or directory, open '/var/task/.next/server/chunks/schema.prisma'](https://github.com/prisma/prisma/issues/16117)~
3. ~[Next.js 13: Client side navigation does not update head](https://github.com/vercel/next.js/issues/42414)~
2022-10-26 13:18:06 +00:00
2022-11-22 15:06:57 +00:00
## Why not trpc, Turborepo or X?
2022-10-26 13:18:06 +00:00
I might add this later. For now, I want to see how far we can get using Next.js only.
If you have some suggestions, feel free to create an issue.
## Running Locally
1. Install dependencies using Yarn:
```sh
yarn
```
2. Copy `.env.example` to `.env.local` and update the variables.
3. Start the development server:
```sh
yarn dev
```
## License
Licensed under the [MIT license](https://github.com/reflexjs/reflex/blob/master/LICENSE).