Coder Social home page Coder Social logo

eric013 / api Goto Github PK

View Code? Open in Web Editor NEW

This project forked from staart/api

0.0 2.0 0.0 16.27 MB

๐Ÿ๐Ÿ› ๏ธ SaaS backend & API framework based on @nestjs

Home Page: https://staart.js.org/api

License: MIT License

TypeScript 97.06% HTML 2.41% JavaScript 0.29% Dockerfile 0.23%

api's Introduction

Staart API

Staart API is a Node.js backend starter for SaaS startups written in TypeScript. It has all the features you need to build a SaaS product, like user management and authentication, billing, organizations, GDPR tools, API keys, rate limiting, superadmin impersonation, and more.

Status
Build Node CI Snyk Vulnerabilities for GitHub Repo Dependencies Dev dependencies
PRs Pull Request Labeler PR Generator CI Merge PRs
Community Contributors GitHub Type definitions npm package version semantic-release

Staart API is build to work with Staart UI, the frontend PWA starter for SaaS startups.

โš ๏ธ v3 BETA WARNING: The master branch and all 3.x releases are currently in beta. For production, use v1.x instead.

โญ Features

๐Ÿ†• New in v2

  • Casbin-powered permission management
  • JWT-powered single-use coupon codes
  • Redis-powered queues for outbound emails and logs
  • Cloud agnostic, no longer specific to AWS
  • Staart scripts for building and deploying
  • Async JSON response and smart controller injection

๐Ÿ” Security

  • JWT-powered authentication and user management
  • TOTP-powered two-factor authentication (2FA)
  • OAuth2 login with third-party accounts
  • Location-based login verification
  • Security event logging and history

๐Ÿ’ณ SaaS

  • Stripe-powered recurring billing
  • Teams with managed user permissions
  • CRUD invoices, methods, transactions, etc.
  • Rich HTML transactional emails
  • GDPR-compliant data export and delete
  • API gateway with API keys and rate limiting
  • Domain verification with auto-approve members

๐Ÿ‘ฉโ€๐Ÿ’ป Developer utilities

  • OvernightJS-powered decorators and class syntax
  • Injection-proof helpers for querying databases
  • Data pagination and CRUD utilities for all tables
  • Authorization helpers
  • Caching and invalidation for common queries
  • User impersonation for super-admin
  • Easy redirect rules in YAML
  • ElasticSearch-powered server and event logs

๐Ÿ›  Usage

  1. Use this template or fork this repository
  2. Install dependencies with npm install
  3. Add a .env file based on config.ts.
  4. Create MariaDB/MySQL tables based on schema.sql
  5. Add your controllers in the ./src/controllers directory
  6. Generate your app.ts file using staart controllers
  7. Build with staart build and deploy with staart launch

Updating Staart

To update your installation of Staart, run the following:

staart update api

If you've used the "Use this template" option on GitHub, you might have to force pull from staart/api the first time since the histories wouldn't match. You can use the flag --allow-unrelated-histories in this case.

๐Ÿ’ป Docs

View docs site โ†’

View TypeDoc โ†’

View API demo โ†’

View frontend demo โ†’

๐Ÿ—๏ธ Built with Staart

The Staart ecosystem consists of open-source projects to build your SaaS startup, written in TypeScript.

Package
๐Ÿ› ๏ธ Staart API Node.js backend with RESTful APIs Build status Docs npm package version
๐ŸŒ Staart UI Frontend Vue.js Progressive Web App Build status Docs npm package version
๐Ÿ“‘ Staart Site Static site generator for docs/helpdesk Build status Docs npm package version
๐Ÿ“ฑ Staart Native React Native app for Android and iOS Build status Docs npm package version
๐ŸŽจ Staart.css Sass/CSS framework and utilities Build status Docs npm package version
๐Ÿ“ฆ Staart Packages Helper functions and utility packages Build status Custom badge

๐Ÿ’ Sponsors

The development of Staart projects is supported by these wonderful companies. Find us on OpenCollective


Oswald Labs

O15Y

Speakup

Netlify

Koj

๐Ÿ“„ License

api's People

Contributors

allcontributors[bot] avatar anandchowdhary avatar dependabot-preview[bot] avatar dependabot-support avatar dependabot[bot] avatar ektek avatar findinganand avatar imgbotapp avatar kuttim avatar semantic-release-bot avatar snyk-bot avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.