diff --git a/README.md b/README.md index 67943c7..a0a44d4 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,46 @@ -# Create T3 App +# [CSV Importer](https://importer.sadmn.com) -This is a [T3 Stack](https://create.t3.gg/) project bootstrapped with `create-t3-app`. +This is a csv-importer built with `shadnc/ui`, `radix ui`, `react-dropzone`, and `papaparse`. It is bootstrapped with `create-t3-app`. -## What's next? How do I make an app with this? +[![CSV Importer](./public/images/screenshot.png)](https://importer.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) +- **DND Uploader:** [react-dropzone](https://react-dropzone.js.org/) +- **Storage:** [uploadthing](https://uploadthing.com) +- **CSV Parsing:** [Papaparse](https://www.papaparse.com) -- [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] Upload CSV file +- [x] Parse CSV file +- [x] Preview CSV file in a table +- [x] Map CSV fields to corresponding table fields +- [x] Import CSV data to database -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/csv-importer + ``` + +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. diff --git a/public/images/screenshot.png b/public/images/screenshot.png new file mode 100644 index 0000000..96625d9 Binary files /dev/null and b/public/images/screenshot.png differ diff --git a/public/site.webmanifest b/public/site.webmanifest index d5ca208..4fd9ec5 100644 --- a/public/site.webmanifest +++ b/public/site.webmanifest @@ -1,6 +1,6 @@ { - "name": "Csv Importer", - "short_name": "Csv Importer", + "name": "CSV Importer", + "short_name": "CSV Importer", "icons": [ { "src": "/icon.png", diff --git a/src/app/layout.tsx b/src/app/layout.tsx index 09bd565..04b0393 100644 --- a/src/app/layout.tsx +++ b/src/app/layout.tsx @@ -22,10 +22,8 @@ export const metadata: Metadata = { "nextjs", "react", "react server components", - "table", - "react-table", - "tanstack-table", - "shadcn-table", + "importer", + "csv-importer", ], authors: [ { diff --git a/src/components/csv-importer.tsx b/src/components/csv-importer.tsx index b16d9f3..2ead7f6 100644 --- a/src/components/csv-importer.tsx +++ b/src/components/csv-importer.tsx @@ -108,7 +108,7 @@ export function CsvImporter({ {step === "upload" ? ( - Import CSV + Upload CSV Drag and drop your files here or click to browse. @@ -144,9 +144,9 @@ export function CsvImporter({
- Map Fields + Map fields - Map the CSV fields to the database fields + Map the CSV fields to the corresponding table fields.