diff --git a/README.md b/README.md index ee9e163..1b79174 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,31 @@ -# Sr Izan Stack +# Echospace -Sr Izan Stack is a next.js template which runs on modern technologies, with a focus on developer experience and ease-of-use. +Echospace is a developer-centric user feedback platform that makes collecting and managing user feedback simple and streamlined. -## The stack +## Features -- Framework: [Next.js](https://nextjs.org/) -- Language: [TypeScript](https://www.typescriptlang.org/) -- Styling: [Tailwind CSS](https://tailwindcss.com/) -- UI Library: [shadcn/ui](https://ui.shadcn.com) -- Authentication: [Lucia](https://lucia-auth.com) -- Deployment: [Vercel](https://vercel.com) -- Database: [Supabase Postgres](https://supabase.com) with [Prisma](https://www.prisma.io/) +- **Project Management**: Create and manage multiple feedback collection projects +- **Custom Data Fields**: Define custom data fields to collect alongside feedback +- **API Integration**: Simple REST API for collecting feedback +- **Rate Limiting**: Configurable rate limits per project +- **GitHub Integration**: Link projects to GitHub repositories -## Why (insert tool here)? +## Tech Stack -- **Next.js**: I like the next.js app router because it has a very good developer experience and it's very easy to use. -- **TypeScript**: Don't even need to explain why -- **Tailwind CSS**: I like the utility-first approach and the speed of development it provides -- **shadcn/ui**: Copy-pasting components is so fire (also is Radix UI) -- **Lucia**: The DevEX is amazing and it's very easy to use -- **Vercel**: Next.js and Vercel are like bread and butter, but it's a bit slow with the free tier. -- **MongoDB Atlas**: It has a very generous free tier, and I'm choosing NoSQL because Postgres hates me. -- **Prisma**: Even though there are solid competitors like Drizzle, Prisma is easy to use, understand, and fast enough for my use case. \ No newline at end of file +- **Framework**: Next.js 14 with App Router +- **Language**: TypeScript +- **Styling**: Tailwind CSS with shadcn/ui components +- **Authentication**: Lucia with GitHub OAuth +- **Database**: PostgreSQL with Prisma ORM +- **Deployment**: Docker with automated builds + +## Getting Started +Selfhosting is not recommended (you can use the free hosted version), but you can do so! A docker image is available at `srizan10/echospace`. + +1. Clone the repository +2. Set up environment variables: +```env +DATABASE_URL=postgresql://... +GITHUB_CLIENT=your_github_client_id +GITHUB_SECRET=your_github_secret +``` \ No newline at end of file