Quick Waitlist

Quick Waitlist is a simple boilerplate for creating a fast waitlist demo website in less than 2 minutes. Users can choose from different types of templates to suit their needs.

Table of Contents

• Tech Stack
• Features
• Getting Started
  • Prerequisites
  • Installation
  • Running the Development Server
  • Configuration
  • Generating Prisma Client
• Contributing
• License
• Contact

Tech Stack

• Next.js (server actions): For building the frontend and backend of the application.
• Postgres (database): For robust and scalable data storage.
• Resend: For managing email notifications.

Features

• Quick setup and deployment.
• Server-side rendering with Next.js.
• Efficient database management with Postgres.
• Easy email notification integration with Resend.
• Multiple templates to choose from.

Getting Started

Prerequisites

Before you begin, ensure you have the following installed on your machine:

• Node.js (v14 or later)
• npm, yarn, pnpm, or bun

Installation

1. Clone the repository:

   git clone https://github.com/blyncnov/quick-waitlist.git
   cd quick-waitlist

2. Install dependencies:

   npm install
   # or
   yarn install
   # or
   pnpm install
   # or
   bun install

Running the Development Server

To start the development server, run one of the following commands:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

Configuration

1. Create a .env file in the root directory and add the following environment variables:

   # Connect to Railway via connection pooling
   DATABASE_URL= <Postgres_Database_URL>
   
   # Resend API_KEY
   RESEND_API_KEY =  <RESEND_API_KEY>
   

Generating Prisma Client

After configuring your environment variables, you need to generate the Prisma client:

npx prisma generate

Contributing

Contributions are welcome! Please follow these guidelines:

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

Please open an issue or submit a pull request for any bugs or feature requests.

License

This project is licensed under the MIT License.

Contact

For any questions or inquiries, please contact bholuwatife00@gmail.com. You can also visit my portfolio website or connect with me on Twitter.