user creation and invites
This commit is contained in:
29
README.md
29
README.md
@@ -3,13 +3,15 @@ My goal for this project is to be an all-in-one self hosted event planner for ma
|
||||
|
||||
## Table of Contents
|
||||
- [Planned Features](#planned-features)
|
||||
- [Updates](#updates)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Built With](#built-with)
|
||||
|
||||
## Planned Features
|
||||
- [x] Account Creation
|
||||
- [x] First time setup to create the admin user
|
||||
- [ ] Invite partner and or "Planner" via email (smtp)
|
||||
- [x] Invite users via email (smtp) users can be COUPLE, PLANNER, GUEST
|
||||
- [x] Create local accounts (no use of SMTP)
|
||||
- [ ] Creating custom events
|
||||
- [ ] Information about each event
|
||||
- Date/Time
|
||||
@@ -29,6 +31,15 @@ My goal for this project is to be an all-in-one self hosted event planner for ma
|
||||
- Seating Charts
|
||||
- Calendar/Timeline Builder
|
||||
|
||||
## Updates
|
||||
#### 6.24.25
|
||||
- added ability to invite users via email making use of a smtp server and nodemailer
|
||||
- inviteTokens added to db which are used to sign up and expire onDate and after use
|
||||
- added ability to create local users if you don't want to use smtp `/admin/create-user`
|
||||
- created user pages
|
||||
- added usernames to `Users` table
|
||||
- updated first time setup to include username creation
|
||||
|
||||
## 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.
|
||||
|
||||
@@ -42,6 +53,14 @@ git clone https://github.com/briannelson95/wedding-planner.git
|
||||
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/wedding_planner
|
||||
NEXTAUTH_SECRET=your-secret
|
||||
NEXTAUTH_URL=http://localhost:3000
|
||||
NEXT_PUBLIC_BASE_URL=http://localhost:3000
|
||||
|
||||
SMTP_HOST=smtp.example.com
|
||||
SMTP_PORT=587
|
||||
SMTP_USER=your@email.com
|
||||
SMTP_PASS=yourpassword
|
||||
SMTP_FROM_NAME=Wedding Planner
|
||||
SMTP_FROM_EMAIL=your@email.com
|
||||
```
|
||||
|
||||
3. Start the database
|
||||
@@ -49,7 +68,13 @@ NEXTAUTH_URL=http://localhost:3000
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
4. Install dependencies and start the front end with `npm i && npm run dev` or `bun i && bun dev`
|
||||
4. Migrate and Generate the Prima files
|
||||
```
|
||||
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`
|
||||
|
||||
## Built With
|
||||
- NextJS 15
|
||||
|
||||
Reference in New Issue
Block a user