dimimikadze / fest

SaaS boilerplate built with Node.js & React.

Fest

Fest is a SaaS boilerplate built with Node.js & React. It's equipped with the following features:

• User authentication and authorization with email verification and password reset.
• Organizations management system.
• Invite system: users can join organizations by having different roles.
• Secure API endpoints and Front-end routes with role-based authorization.

Tech Stack

The repository is structured as a Monorepo using Nx. It contains two apps:

• api A Nest.js application, with Prisma ORM.
• frontend A Next.js application with MUI React components.

And a shared library for sharing common Typescript types, constants, and utility functions across apps.

auth0 is used for Identity management and PostgreSQL as a database.

Requirements

• You'll need docker installed on your machine to run the PostgreSQL.
• For identity management to work, you need to create an account in auth0 and create two apps in there as described in here.
• Postmark is used in the repository as an email client. To send emails with Postmark, grab the key from their dashboard and add it to apps/api/.env. If you want to use another email client, change the corresponding code in apps/api/src/mail.service.ts.

Getting started

• Clone the repo: git clone https://github.com/DimiMikadze/fest.git.
• Install dependencies: yarn.
• Rename apps/api/.env.example to .env and apps/frontend/.env.local.example to .env.local and update environment variables.
• Navigate to the apps/api directory and run docker-compose up, to run the PostgreSQL instance.
• run yarn prisma:migrate:dev init to run the initial migrations.
• run yarn dev from the project's root, to run API and frontend apps in the development mode.

License

Fest is an open-source software licensed as MIT.

fest's Issues

No example components showing Prisma interaction

Would be great for the children of here to contain some example React component that reads/edits some data via Prisma.

README does not mention POSTGRES_USER, POSTGRES_DB, and POSTGRES_PASSWORD

These seem to be necessary in .env file in order for docker-compose up to work as expected, yet are not included in the template or instructions

Lack of Billing/Subscriptions/Payments, or User Profile page

If this is meant to be a boilerplate or template for SaaS, I think it will be crucial to include Billing/Payments/Subscriptions page (e.g. via Stripe) as well as a user profile page. If you include these, then another benefit will be the example of navigation between pages.

Database initialization not included in instructions

After following instructions from README, navigating to localhost:3000 triggers this line which produces following error (which suggests that some step in instructions is missing in order to initialize the database)

[Nest] 22180  - 01/03/2023, 3:27:40 PM   ERROR [ExceptionsHandler] 
Invalid `prisma.user.findUnique()` invocation:


The table `public.User` does not exist in the current database.

Update: From experimenting, it seems README should include that the following command is needed:
yarn prisma:migrate:dev init

Default From address in Mail Service is hard-coded, causes Postmark warning

If you unknowingly leave this line as "[email protected]", it will raise an error that this isn't a configured Sender Signature. It seems no-reply is discouraged by Postmark.

Maybe instead make that line use this.config.get('POSTMARK_SENDER') and add POSTMARK_SENDER to the example env file?

Error is hidden if you leave trailing slash in AUTH0_DOMAIN

If you include the trailing slash "/" in the AUTH0_DOMAIN as shown in these instructions, all you will see is 401 Unauthorized trying to call auth/me endpoint after logging in. Maybe it's best for the error “jwksError: Not Found” to be logged, because it wasn't obvious this was the problem. For reference: solution