Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sadmann7 committed May 12, 2024
1 parent 2eea8f6 commit 12d4d60
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 18 deletions.
47 changes: 30 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,42 @@
# Create T3 App
# [Sortable](https://sortable.sadmn.com)

This is a [T3 Stack](https://create.t3.gg/) project bootstrapped with `create-t3-app`.
This is a sortable component built with `shadnc/ui`, `radix ui`, and `dnd-kit`. It is bootstrapped with `create-t3-app`.

## What's next? How do I make an app with this?
[![Sortable](./public/images/screenshot.png)](https://sortable.sadmn.com)

We try to keep this project as simple as possible, so you can start with just the scaffolding we set up for you, and add additional things later when they become necessary.
## Tech Stack

If you are not familiar with the different technologies used in this project, please refer to the respective docs. If you still are in the wind, please join our [Discord](https://t3.gg/discord) and ask for help.
- **Framework:** [Next.js](https://nextjs.org)
- **Styling:** [Tailwind CSS](https://tailwindcss.com)
- **UI Components:** [shadcn/ui](https://ui.shadcn.com)
- **Drag and Drop:** [dnd-kit](https://dndkit.com)
- **Validation:** [Zod](https://zod.dev)

- [Next.js](https://nextjs.org)
- [NextAuth.js](https://next-auth.js.org)
- [Prisma](https://prisma.io)
- [Drizzle](https://orm.drizzle.team)
- [Tailwind CSS](https://tailwindcss.com)
- [tRPC](https://trpc.io)
## Features

## Learn More
- [x] Headless `Sortable` ui primitives built with `shadnc/ui`, `radix ui`, and `dnd-kit`.
- [x] Integration with `useFieldArray` of `react-hook-form`, and `tanstack-table`.

To learn more about the [T3 Stack](https://create.t3.gg/), take a look at the following resources:
## Running Locally

- [Documentation](https://create.t3.gg/)
- [Learn the T3 Stack](https://create.t3.gg/en/faq#what-learning-resources-are-currently-available) — Check out these awesome tutorials
1. Clone the repository

You can check out the [create-t3-app GitHub repository](https://github.com/t3-oss/create-t3-app) — your feedback and contributions are welcome!
```bash
git clone https://github.com/sadmann7/uploader
```

2. Install dependencies using pnpm

```bash
pnpm install
```

3. Start the development server

```bash
pnpm run dev
```

## How do I deploy this?

Follow our deployment guides for [Vercel](https://create.t3.gg/en/deployment/vercel), [Netlify](https://create.t3.gg/en/deployment/netlify) and [Docker](https://create.t3.gg/en/deployment/docker) for more information.
Follow the deployment guides for [Vercel](https://create.t3.gg/en/deployment/vercel), [Netlify](https://create.t3.gg/en/deployment/netlify) and [Docker](https://create.t3.gg/en/deployment/docker) for more information.
Binary file added public/images/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/config/site.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export type SiteConfig = typeof siteConfig

export const siteConfig = {
name: "Sortable",
description: "Sortable component built with dnd kit, shadcn/ui, and radix ui",
description: "Sortable component built with shadcn/ui, radix ui, and dnd-kit",
url:
env.NODE_ENV === "development"
? "http://localhost:3000"
Expand Down

0 comments on commit 12d4d60

Please sign in to comment.