From 1b8fe8920fd94fc7b3d91710bf08b8bcd6ac578b Mon Sep 17 00:00:00 2001 From: Brian Nelson Date: Sun, 29 Jun 2025 11:14:21 -0400 Subject: [PATCH] prepping for first release --- CHANGELOG.md | 25 +++++++++++++++++++++++++ LICENSE | 9 +++++++++ README.md | 37 +++++++++++++++++++++++++++++++++---- docker-compose.yml | 36 ++++++++++++++++++------------------ 4 files changed, 85 insertions(+), 22 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 LICENSE diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..7e0217d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,25 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/). + +## [0.1.0] - 2025-07-01 +### Added +- Guest book with contact info and RSVP linking +- Markdown-powered event notes +- Todo list system per event +- First-time user setup +- Email and local user invitations +- Admin-only user creation +- Role-based access control (COUPLE, PLANNER, GUEST) +- Docker support (Postgres + App) +- Modern Next.js 15 app structure + +### Fixed +- Setup flow error handling and schema validations + +### Changed +- Event creation now uses modal instead of separate page + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c14f6fd --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) 2025 Brian Nelson + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the “Software”), to deal +in the Software without restriction... + +[Include the full MIT text or use GitHub’s license picker which autogenerates it.] \ No newline at end of file diff --git a/README.md b/README.md index a2415da..e91ba95 100644 --- a/README.md +++ b/README.md @@ -62,8 +62,15 @@ My goal for this project is to be an all-in-one self hosted event planner for ma - search GuestBook to add guests - change status of RSVP +#### 6.29.25 – Notes and Tasks +- Markdown note field per event +- Inline editing with live preview +- Task list per event with due dates & completion toggle + ## Getting Started -This is very much a work in progress but this `README` will stay up to date on working features and steps to get it running **in its current state**. That being said if you're interested in starting it as is, you can follow these instructions. +This app is fully deployable with Docker or runnable in development with Node. + +### Development Mode 1. Clone the repo ``` @@ -87,7 +94,7 @@ SMTP_FROM_EMAIL=your@email.com 3. Start the database ``` -docker compose up -d +docker compose up -d db ``` 4. Migrate and Generate the Prima files @@ -96,7 +103,27 @@ npx prisma migrate dev --name init npx prisma generate ``` -5. Install dependencies and start the front end with `npm i && npm run dev` or `bun i && bun dev` +5. Install dependencies and start app +``` +npm install +npm run dev +``` + +### Self-Hosted (Production) via Docker +1. Copy `.env.production` +Make a copy of your .env as .env.production and customize values. + +2. Update `docker-compose.yml` +Already included in the repo – here's what it does: +- Runs a postgres:15 container +- Builds the app from the Dockerfile +- Runs migrations before starting the frontend + +3. Run the app +``` +docker compose up --build +``` +This will expose your instance at http://localhost:3000 ## Built With - NextJS 15 @@ -104,4 +131,6 @@ npx prisma generate - Prisma - TailwindCSS - PostgresDB -- Docker \ No newline at end of file +- Docker + +### Ready to start planning your wedding or big event? Try it now or contribute ideas via [GitHub Issues](https://github.com/briannelson95/wedding-planner/issues). diff --git a/docker-compose.yml b/docker-compose.yml index 21d5333..7640f48 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -11,22 +11,22 @@ services: ports: - "5432:5432" - # migrate: - # build: . - # command: npx prisma migrate deploy - # depends_on: - # - db - # environment: - # DATABASE_URL: postgres://postgres:postgres@db:5432/wedding_planner + migrate: + build: . + command: npx prisma migrate deploy + depends_on: + - db + environment: + DATABASE_URL: postgres://postgres:postgres@db:5432/wedding_planner - # app: - # build: . - # ports: - # - "3000:3000" - # depends_on: - # - db - # - migrate - # environment: - # DATABASE_URL: postgres://postgres:postgres@db:5432/wedding_planner - # NEXTAUTH_SECRET: changeme - # NEXTAUTH_URL: http://localhost:3000 + app: + build: . + ports: + - "3000:3000" + depends_on: + - db + - migrate + environment: + DATABASE_URL: postgres://postgres:postgres@db:5432/wedding_planner + NEXTAUTH_SECRET: changeme123 + NEXTAUTH_URL: http://localhost:3000