![\"CASE\"](\"https://case.app/assets/images/logo-black.svg\"){kind=logo}
\n \n\n \n \n \n
\nA complete backend without leaving your IDE\n
\n \n ![\"npm\"](\"https://img.shields.io/npm/v/%40casejs%2Fcase\")
![\"CodeFactor](\"https://img.shields.io/codefactor/grade/github/casejs/case\")
![\"Discord\"](\"https://img.shields.io/discord/1089907785178812499?label=discord\")
![\"Support](\"https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg\"){kind=icon}
\n \n \n ![\"Licence](\"https://img.shields.io/badge/licence-MIT-green\"){kind=icon}
\n
![\"CASE](\"./docs/assets/images/cat-list.png\")
\n\n## What is CASE ?\n\nCASE is a Typescript lightweight **BaaS (Backend As A Service)** requiring minimal coding.\n\nIt provides a complete backend to your client app without the hassle that comes with it.\n\n## Key features\n\n- ā” **Instant backend with DB, REST API and Admin panel** without any configuration\n- š§ **Smart SDK** to import in your favorite JS front-end\n- š ļø **Essential features** like Auth, Storage, Validation and Hooks\n\n## Forget about drag-and-drop visual builders\n\nWith CASE, you structure your data using TypeScript classes straight from your coding environment.\n\n```js\n// entities/cat.entity.ts\n@Entity()\nexport class Cat extends BaseEntity {\n @Prop()\n name: string\n\n @Prop({\n type: PropType.Date\n })\n birthDate: Date\n\n @Prop({\n type: PropType.Relation,\n options: {\n entity: Owner\n }\n })\n owner: Owner\n}\n```\n\n## Effortless integration in your client app\n\nAnd allow the following code in your JS client built with your favorite stack: [React](https://docs.case.app/connect/react), [Svelte](https://docs.case.app/connect/svelte), [Angular](https://docs.case.app/connect/angular), [Vue](https://docs.case.app/connect/vue) or any front-end. You can even use it in NodeJS.\n\n```js\nimport CaseClient from '@casejs/case-client'\n\n// Init SDK\nconst cs = new CaseClient()\n\n// Get all cats with their owner\nconst cats = await cs.from('cats').with(['owner']).find()\n\n// Filter cats.\nconst cats = await cs\n .from('cats')\n .where('breed = siamese')\n .andWhere('birthDate > 2020-01-01')\n .find()\n\n// Create a new cat.\nconst newCat = await cs.from('cats').create({\n name: 'Milo',\n age: 2\n})\n\n// Upload.\nconst fileUrl: string = await cs.from('cats').addFile(file)\n\n// Login.\nawait cs.login('users', 'user1@case.app', 'case')\n```\n\n## Getting started\n\n### Prerequisites\n\n- [NodeJS](https://nodejs.org/en/) (**v16.14.0** or higher). The recommended version is **18.x**.\n\n### Create your CASE project\n\nRun the following on your terminal replacing `my-case-app` with your app's name:\n\n```\nnpx create-case-app my-case-app\n```\n\nThen serve the app locally:\n\n```\ncd my-case-app\nnpm start\n```\n\nš **Your backend is ready !**\n