remult Download - remult исходный код скачать

Реконструкция

Полный стек Crud, упрощенный, с объектами TypeScript SSOT

Учебные пособия | QuickStart | Пример приложения

Что такое Remult?

Remult использует объекты TypeScript в качестве единого источника истины для: ✅ Crud + API в реальном времени, ✅ Frontend Type-Safe Client и ✅ Backend Orm.

⚡ Zero-BoilerPlate Crud + API в реальном времени с подкидкой, сортировкой и фильтрацией
? Fullstack Type Speection для запросов API, мутаций и RPC, без генерации кода
Проверка ввода, определенная один раз , работает как на бэкэнд, так и на фронте для лучшего UX
Мелкозернистый авторизация API на основе кода
? Постепенно принято

Remult поддерживает все основные базы данных , в том числе: PostgreSQL, MySQL, SQLite, MongoDB, MSSQL и Oracle.

Remult - это фронтальная и бэкэнд -рамка агностика и поставляется с адаптерами для Express, Fastify, Next.js, Nuxt, Sveltekit, Solidstart, Nest, Koa, Hapi и Hono.

Хотите познакомиться из первых рук? Попробуйте наш интерактивный онлайн -учебник.

Remult продвигает постоянный синтаксис запросов как для кода, так и для бэкэнд :

 // Frontend - GET: /api/products?_limit=10&unitPrice.gt=5,_sort=name
// Backend  - 'select name, unitPrice from products where unitPrice > 5 order by name limit 10'
await repo ( Product ) . find ( {
  limit : 10 ,
  orderBy : {
    name : 'asc' ,
  } ,
  where : {
    unitPrice : { $gt : 5 } ,
  } ,
} )

// Frontend - PUT: '/api/products/product7' (body: { "unitPrice" : 7 })
// Backend  - 'update products set unitPrice = 7 where id = product7'
await repo ( Product ) . update ( 'product7' , { unitPrice : 7 } )

Использование

Определить схему в коде

 // shared/product.ts

import { Entity , Fields } from 'remult'

@ Entity ( 'products' , {
  allowApiCrud : true ,
} )
export class Product {
  @ Fields . cuid ( )
  id = ''

  @ Fields . string ( )
  name = ''

  @ Fields . number ( )
  unitPrice = 0
}

Не нравятся декораторы? У нас полная поддержка работы без декораторов

Добавить API Backend с одной строкой кода

Пример:

 // backend/index.ts

import express from 'express'
import { remultExpress } from 'remult/remult-express' // adapters for: Fastify,Next.js, Nuxt, SvelteKit, SolidStart, Nest, more...
import { createPostgresDataProvider } from 'remult/postgres' // supported: PostgreSQL, MySQL, SQLite, MongoDB, MSSQL and Oracle
import { Product } from '../shared/product'

const app = express ( )

app . use (
  remultExpress ( {
    entities : [ Product ] ,
    dataProvider : createPostgresDataProvider ( {
      connectionString : 'postgres://user:password@host:5432/database"' ,
    } ) ,
  } ) ,
)

app . listen ( )

Remult добавляет обработчики маршрута для полностью функционального API REST и конечных точек в реальном времени, при желании включает в себя Open API-спецификацию и конечную точку GraphQL

Получить данные с кодом защитника, безопасного типа

 const [ products , setProducts ] = useState < Product [ ] > ( [ ] )

useEffect ( ( ) => {
  repo ( Product )
    . find ( {
      limit : 10 ,
      orderBy : {
        name : 'asc' ,
      } ,
      where : {
        unitPrice : { $gt : 5 } ,
      } ,
    } )
    . then ( setProducts )
} , [ ] )

Живые запросы в реальном времени

 useEffect ( ( ) => {
  return repo ( Product )
    . liveQuery ( {
      limit : 10 ,
      orderBy : {
        name : 'asc' ,
      } ,
      where : {
        unitPrice : { $gt : 5 } ,
      } ,
    } )
    . subscribe ( ( info ) => {
      setProducts ( info . applyChanges )
    } )
} , [ ] )

☑ Проверка данных и ограничения данных - определено один раз

 import { Entity , Fields , Validators } from 'remult'

@ Entity ( 'products' , {
  allowApiCrud : true ,
} )
export class Product {
  @ Fields . cuid ( )
  id = ''

  @ Fields . string ( {
    validate : Validators . required ,
  } )
  name = ''

  @ Fields . number < Product > ( {
    validate : ( product ) => product . unitPrice > 0 || 'must be greater than 0' ,
  } )
  unitPrice = 0
}

Принудительно на переднем крае:

 try {
  await repo ( Product ) . insert ( { name : '' , unitPrice : - 1 } )
} catch ( e : any ) {
  console . error ( e )
  /* Detailed error object ->
{
  "modelState": {
    "name": "Should not be empty",
    "unitPrice": "must be greater than 0"
  },
  "message": "Name: Should not be empty"
}
*/
}

Принудительно в бэкэнд:

 // POST '/api/products' BODY: { "name":"", "unitPrice":-1 }
// Response: status 400, body:
{
  "modelState" : {
    "name" : "Should not be empty" ,
    "unitPrice" : "must be greater than 0"
  } ,
  "message" : "Name: Should not be empty"
}

Закрепить API с мелкозернистым разрешением

@ Entity < Article > ( 'Articles' , {
  allowApiRead : true ,
  allowApiInsert : Allow . authenticated ,
  allowApiUpdate : ( article ) => article . author == remult . user . id ,
  apiPrefilter : ( ) => {
    if ( remult . isAllowed ( 'admin' ) ) return { }
    return {
      author : remult . user . id ,
    }
  } ,
} )
export class Article {
  @ Fields . string ( { allowApiUpdate : false } )
  slug = ''

  @ Fields . string ( { allowApiUpdate : false } )
  authorId = remult . user ! . id

  @ Fields . string ( )
  content = ''
}

Отношения

 await repo ( Categories ) . find ( {
  orderBy : {
    name : 'asc ' ,
  } ,
  include : {
    products : {
      where : {
        unitPrice : { $gt : 5 } ,
      } ,
    } ,
  } ,
} )

// Entity Definitions
export class Product {
  //...
  @ Relations . toOne ( Category )
  category ?: Category
}
export class Category {
  //...
  @ Relations . toMany < Category , Product > ( ( ) => Product , `category` )
  products ?: Product [ ]
}

Автоматический администратор пользовательского интерфейса

А как насчет сложного круга?

Хотя простой CRUD не должен требовать какого -либо бэкэнд -кодирования, использование реконструкции означает, что иметь возможность обрабатывать любой сложный сценарий, управляя бэкэнд многочисленными способами:

Бэкэнд вычисленные (только для чтения) - от простых выражений до сложных поисков данных или даже прямого доступа DB (SQL)
Пользовательские побочные эффекты с крючками жизненного цикла объекта (до/после сохранения/удаления)
Только бэкэнд только обновляемые поля (например, «Последнее обновление»)
Отношения
Закаленные конечные точки с таковым
Руловые низкоуровневые конечные точки (экспресс, фазвинг, коа, другие…)

Установка

Пакет Remult является одним и тем же как для пакета Frontend, так и для бэкэнда. Установите его один раз для монолитного проекта или за репо в Monorepo.

npm i remult

Учебные пособия

Лучший способ выучить Remult - это следовать учебному пособию простого веб -приложения Todo с бэкэнд Express node.js.

Учебник с React
Учебное пособие с Angular
Учебник с Vue
Учебник с next.js
Учебное пособие с Sveltekit
Учебник с SolidStart

Демо

Видео миниатюр

Посмотрите демо -код на YouTube здесь (14 минут)

Документация

Документация охватывает основные особенности Remult. Тем не менее, это все еще является незавершенной работой.

Пример приложения

FullStack ToDomvc пример с React и Express. (Исходный код | CodeSandbox)
Демонстрация CRM с базой данных Greact + MUI Front-Tend и Postgres.

Статус

Remult готов к производству и, фактически, используется в производственных приложениях с 2018 года. Однако мы сохраняем основную версию в нуле, чтобы мы могли использовать обратную связь сообщества для завершения API V1.

Мотивация

Веб-разработка полного стека (все еще) слишком сложна. Simple Crud, общее требование любого бизнес -приложения, должно быть простым в создании, обслуживании и расширении при возникновении необходимости.

Remult устраняет повторяющийся, шаблонный, склонный к ошибкам и плохо спроектированный код, с одной стороны, и обеспечивает полную гибкость и управление с другой. Remult помогает создавать приложения FullStack, используя только код TypeScript, который вы можете легко следовать и безопасно рефактор , и прекрасно вписывается в любой существующий или новый проект, будучи минималистичным и совершенно неопитанным в отношении выбора разработчика других структур и инструментов.

Другие структуры, как правило, впадают в слишком большую абстракцию (без кода, низкий код, BAAS), либо частичную абстракцию (Frameworks MVC, GraphQL, ORMS, генераторы API, генераторы кодов) и имеют тенденцию быть самоуверенными в отношении цепи инструментов разработки, среды развертывания, конфигурации/конвенций или DSL. Remult пытается добиться лучшего баланса.