Skip to content

Latest commit

 

History

History
142 lines (94 loc) · 5.07 KB

README.md

File metadata and controls

142 lines (94 loc) · 5.07 KB
Raw

Stack Logo

📘 Documentation | ☁️ Hosted Version | ✨ Demo | Discord

💬 What is Stack?

Stack is an open-source, self-hostable, and highly customizable authentication and user management system.

We provide frontend and backend libraries for Next.js, React, and JavaScript. You can set it up in one minute and scale with the project as it grows.

Here are some of the components you get out-of-the-box:

Stack Sign Up Page

Here is the user/project management dashboard:

Stack Dashboard

✨ Features

  • Composable React components & hooks
  • OAuth (Google, Facebook, GitHub, etc.)
  • Magic link and email password authentication (with email verification and password reset)
  • Easy to set up with proxied providers (no need to sign up and create OAuth endpoints yourself on all the providers)
  • User management & analytics
  • Teams & permissions
  • User-associated metadata with client-/server-specific permissions
  • Out-of-the-box dark/light mode support
  • Fully customizable UI, or build your own UI with our functions like signInWithOAuth
  • 100% open-source!

🔭 Vision

We all know how much overhead there is when starting a new project. Developers need to handle so many things that aren't even part of their core business, like user authentication, user profiles, payments, dashboards, hosting, and more. Our vision is to build a full-stack framework that handles all of this out-of-the-box with less than 10 minutes of setup, so developers can focus on what they really want to build. Authentication is the first step towards this vision.

🗺️ Roadmap

  • Customizable frontend [20. April 2024]
  • Teams [8. May 2024]
  • Permissions [10. May 2024]
  • New dashboard with Shadcn UI [16. May 2024]
  • Email template editor [28. May 2024]
  • OAuth scope authorization and access token [05. June 2024]
  • Fully API endpoints with OpenAPI schema
  • Webhooks
  • Two factor authentication
  • Backend SDKs for Python
  • User analytics (retention, DAU/MAU, user segments, etc.)
  • Integration with Postgres DB

📦 Installation & Setup

To get started with Stack, you need to create a Next.js project using the App router. Then, you can install Stack by running the following command:

npx @stackframe/init-stack@latest

You will then be guided through the installation process.

For further configuration and usage, refer to our documentation.

🌱 Some community projects built with Stack

🏗️ Development & Contribution

This is for you if you want to contribute to the Stack project or run the Stack dashboard locally.

Please read the contribution guidelines before contributing.

Requirements

  • Node v20
  • pnpm v9
  • Docker

Setup

Pre-populated .env files for the setup below are available and used by default in .env.development in each of the packages. You should copy all the .env.development files to .env.local in the respective packages for local development.

In a terminal, start the dependencies (Postgres and Inbucket) as Docker containers:

docker compose -f dependencies.compose.yaml up

Then open a new terminal:

pnpm install

# Run build to build everything once
pnpm run build

# initialize the database and seed it with some data
pnpm prisma seed

# Run code generation (repeat this after eg. changing the Prisma schema). This is part of the build script, but faster
pnpm run codegen

# Start the dev server
pnpm run dev

# In a different terminal, run tests in watch mode
pnpm run test

You can now open the dashboard at http://localhost:8101, API on port 8102, demo on port 8103, docs on port 8104, Inbucket (e-mails) on port 8105, and Prisma Studio on port 8106.

Your IDE may show an error on all @stackframe/XYZ imports. To fix this, simply restart the TypeScript language server; for example, in VSCode you can open the command palette (Ctrl+Shift+P) and run Developer: Reload Window or TypeScript: Restart TS server.

You can also open Prisma Studio to see the database interface and edit data directly:

pnpm run prisma studio

Database migrations

If you make changes to the Prisma schema, you need to run the following command to create a migration:

pnpm run prisma migrate dev

Contributors

Important: Please read the contribution guidelines carefully and join our Discord if you'd also like to help.

Thanks to our amazing community who have helped us build Stack: