Pagbutlak Website

Official website of Pagbutlak UPV

About The Project

This project is the official website for the student and community publication of CAS in UP Visayas, Pagbutlak.

Getting Started

Prerequisites

• Node.js (recommended to use nvm)

• pnpm

• PostgreSQL (optional)

• Docker (optional)

Installation

1. Clone the repository
2. cp .env.example .env to copy the example environment variables

Option 1: Local (Manual Setup)

1. Create a local PostgreSQL database.
2. pnpm install to install dependencies
3. pnpm dev start the dev server

Option 2: Docker

1. Start the services

   docker-compose up

Usage

1. Open http://localhost:3000 to open the app in your browser
2. Go to http://localhost:3000/admin to open the admin panel
3. Seed the database by clicking the seed button.

Contributing

1. Fork this repository
2. Create a new branch and make your changes

   git switch -c feature/my-feature

3. Commit your changes (follow the Conventional Commits specification)

   git add .
   git commit -m "feat: my feature"
   -- or use commitlint to commit with conventional commits
   pnpm commit

4. Push your branch to your fork

   git push origin feature/my-feature

5. Create a pull request

Acknowledgments

• Payload Website Template for bootstrapping the project