Feature |
Description |
|---|---|
| 1. Privacy Account | A secure, personalized account for your pets with end-to-end encryption powered by Clerk. |
| 2. Share Your Pet's Story | Create captivating posts and albums to showcase your pet's unique personality and adventures. |
| 3. Social Community Engagement | Connect with fellow pet lovers, share tips, and build a supportive community around your furry friend. |
| 4. Interactive Features | Engage with other pet owners through likes, comments, and shares, fostering a vibrant community. |
| 5. Clean, Modern UI using TailwindCSS and Shadcn-UI | A visually appealing and user-friendly interface that provides a seamless experience across devices, built with cutting-edge technologies for optimal performance and responsiveness. |
Category |
Choice |
Descriptions |
|---|---|---|
| Frontend | React | Declarative and component-based for building interactive UIs. |
| Web Framework | Next.js | Server-side rendering and static site generation for SEO and performance. |
| Language | TypeScript | Static typing for improved code maintainability and fewer errors. |
| CSS Framework | Tailwind CSS | Utility-first approach for rapid UI development and customization. |
| Storage Server | Uploadthing | Secure and scalable storage solution for your notes, ensuring data persistence and accessibility across devices. |
| UI Library | Shadcn-UI | Pre-built components for a consistent and modern UI experience. |
| NeonTech | NeonTech | Real-time data management, serverless functions, and efficient queries. |
| Authentication | Clerk | Seamless user authentication and authorization. |
| Lucide Icon | Lucide-Icon | Intuitive and minimalist icons |
| Zod | Zod | TypeScript-first schema validation with static type inference |
| React-Hook-Form | React-Hook-Form | React Hooks for form state management and validation. |
| Framer Motion | Framer-Motion | Motion library for React. |
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
# Clone this repository
$ git clone https://github.com/achris-alonzo30/Epigram.git
# Go into the repository
$ cd Epigram
# Install dependencies
$ npm install or bun install
# Run the app
$ npm run dev or bun run devNeon.Tech Create your account on Neon.Tech for free and get your API keys by following the instructions on the given link.
Clerk Create your account on Clerk for free and get your API keys by following the instructions on the given link.
Uploadthing Create your account on Uploadthing for free and get your API keys by following the instructions on the given link.
Copy this and paste it in your .env or .env.local.
// Signin to Clerk: https://dashboard.clerk.com/
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=
// Uploadthing is a Storage Server. You can start for free: https://uploadthing.com/
UPLOADTHING_SECRET=
UPLOADTHING_APP_ID=
// Neon.Tech provides 1 free database. You can signup and get these .ENV variables to get started: https://neon.tech/
DATABASE_URL=
DIRECT_URL=