Bez Gradski

A modern web application built with the T3 Stack, featuring Next.js, tRPC, Prisma, NextAuth.js, and Tailwind CSS.

Demo

Watch our demo video to see the application in action: https://www.loom.com/share/f99bbe6a5a2240ee8a6dc14a03af1a33

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or newer)
• pnpm (Run npm install -g pnpm to install)
• Docker (for local database)

Getting Started

1. Clone the repository

git clone https://github.com/your-username/bez-gradski.git
cd bez-gradski

2. Install dependencies

pnpm install

3. Set up environment variables

Create a .env file in the root directory:

# Database URL for PostgreSQL
DATABASE_URL="postgresql://postgres:password@localhost:5432/bez-gradski"

# Next Auth
NEXTAUTH_SECRET="your-nextauth-secret"
NEXTAUTH_URL="http://localhost:3000"

# Add any other required environment variables here

4. Start the database

We provide a script to easily start a PostgreSQL database in Docker:

chmod +x start-database.sh  # Make the script executable
./start-database.sh

This script will:

• Check for Docker/Podman installation
• Verify port availability
• Start a PostgreSQL container
• Generate a secure password if you're using the default
• Update your .env file with the new database credentials

5. Database migrations

Run the database migrations to set up your database schema:

pnpm prisma db push  # For development
# or
pnpm prisma migrate deploy  # For production

6. Start the development server

pnpm dev

Your application should now be running at http://localhost:3000

Development

• pnpm dev - Start the development server
• pnpm build - Build the application for production
• pnpm start - Start the production server
• pnpm lint - Run ESLint
• pnpm format - Format code with Prettier
• pnpm type-check - Run TypeScript type checking

Tech Stack

• Next.js - React framework
• tRPC - End-to-end typesafe APIs
• Prisma - Database ORM
• NextAuth.js - Authentication
• Tailwind CSS - CSS framework
• PostgreSQL - Database

Deployment

This application can be deployed on various platforms:

• Vercel
• Netlify
• Docker

For detailed deployment instructions, follow the links above.

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.