Ecmel

An easy-to-use and enterprise-grade Next.js boilerplate.

You don't need to buy templates anymore; Ecmel provides a complete, open-source solution for building SaaS applications quickly and easily.

🌟 Star History

🚀 Getting Started

🖱 One Click Template

📋 Prerequisites

Before you start, make sure you have the following installed:

Bun & Node.js & Git

Linux

  curl -sL https://gist.github.com/tianzx/874662fb204d32390bc2f2e9e4d2df0a/raw -o ~/downloaded_script.sh && chmod +x ~/downloaded_script.sh && source ~/downloaded_script.sh

MacOS

  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  brew install git
  brew install oven-sh/bun/bun
  brew install nvm

PostgreSQL
1. You can use Vercel Postgres or a local PostgreSQL server(add POSTGRES_URL env in .env.local)
```
   POSTGRES_URL = ''
```

Installation

To get started with this boilerplate, we offer two options:

Use the bun create command(🌟Strongly recommend🌟):

bun create ecmel

Manually clone the repository:

git clone https://github.com/suchcodemuchwow/ecmel.git
cd ecmel
bun install

Setup

Follow these steps to set up your project:

Set up the environment variables:

cp .env.example .env.local
// (you must have a database prepared before running this command)
bun db:push

Run the development server:

bun run dev:web

Open http://localhost:3000 in your browser to see the result.
(Optional alpha)bun run tailwind-config-viewer Open http://localhost:3333 in your browser to see your Tailwind CSS configuration

⭐ Features

🐭 Frameworks

Next.js - The React Framework for the Web (with App Directory)
NextAuth.js - Authentication for Next.js
Kysely - The type-safe SQL query builder for TypeScript
React-email - A React renderer for creating beautiful emails using React components

🐮 Platforms

Vercel – Deploy your Next.js app with ease
Stripe – Payment processing for internet businesses
Resend – Email marketing platform for developers

🐯 Enterprise Features

i18n - Support for internationalization
SEO - Search engine optimization
MonoRepo - Monorepo for better code management
T3 Env - Manage your environment variables with ease

🐰 Data Fetching

trpc – End-to-end typesafe APIs made easy
tanstack/react-query – Hooks for fetching, caching and updating asynchronous data in React

🐲 Global State Management

Zustand – Small, fast and scalable state management for React

🐒 UI

Tailwind CSS – Utility-first CSS framework for rapid UI development
Shadcn/ui – Re-usable components built using Radix UI and Tailwind CSS
Framer Motion – Motion library for React to animate components with ease
Lucide – Beautifully simple, pixel-perfect icons
next/font – Optimize custom fonts and remove external network requests for improved performance

🐴 Code Quality

TypeScript – Static type checker for end-to-end type safety
Prettier – Opinionated code formatter for consistent code style
ESLint – Pluggable linter for Next.js and TypeScript
Husky – Git hooks made easy

🐑 Performance

Vercel Analytics – Real-time performance metrics for your Next.js app
bun.sh – npm alternative for faster and more reliable package management

🐘 Database

PostgreSQL – The world's most advanced open source database

📦 Apps and Packages

web: The main Next.js application
ui: Shared UI components
db: Database schema and utilities
auth: Authentication utilities
email: Email templates and utilities

📜 License

This project is licensed under the MIT License. For more information, see the LICENSE file.

🙏 Credits

👨‍💻 Contributors

Made with contrib.rocks.

suchcodemuchwow / ecmel Goto Github PK

ecmel's Introduction