Panache.social is an attempt to build an open-source alternative to HackerNews/Reddit. Our goal is to provide a friendly space to share links, text posts, and more.
- Frontend Framework: Next.js 15.3.3
- Styling: TailwindCSS v4
- UI Components: ShadCN UI
- Database: PostgreSQL 16
- ORM: Drizzle ORM
- Form Handling: React Hook Form
- Validation: Zod
- Authentication: Better Auth
Before you begin, ensure you have the following installed:
- Node.js (Latest LTS version recommended)
- npm (comes with Node.js)
- Docker and Docker Compose (for local development)
- Git
-
Clone the repository
git clone https://github.com/alexisbcz/panache.social cd panache.social -
Environment Setup
cp .env.example .env
Edit
.envwith your configuration values. -
Install Dependencies
npm install
-
Start the Development Environment
# Start the PostgreSQL database docker compose up -d # Push the database schema npx drizzle-kit push # Start the development server npm run dev
-
Access the Application
- Frontend: http://localhost:3000
- Database: localhost:5432
npm run dev- Start development server with Turbopacknpm run build- Build for productionnpm run start- Start production servernpm run format- Format code with Prettiernpm run lint- Run ESLint
Got a cool idea? Here's how to make it happen:
-
Join the Party: First things first - hop into our Discord server. That's where all the magic happens.
-
Check the Issues: Take a look at our GitHub issues - maybe someone already suggested something similar. If not, create a new one!
-
Let's Talk About It: Before you start coding, let's discuss your idea in Discord. We want to make sure it fits with our vision and get some community feedback.
-
Get the Green Light: Once we've discussed and refined your idea, you'll get the go-ahead to start implementing it.
We welcome contributions! Here's how you can help:
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Please ensure your code follows our coding standards and includes appropriate tests.
This project is licensed under the MIT License - see the LICENSE file for details.
If you encounter any issues or have questions, please:
- Check the existing issues
- Create a new issue if needed
- Join our community discussions