CASE

Typescript lightweight Backend-as-a-Service

Backend-as-a-ServiceDashboard
casejs/CASEcase.app@casejs/case-client

README

CASE

A complete backend without leaving your IDE

What is CASE ?


CASE is a Typescript lightweight BaaS (Backend As A Service) requiring minimal coding.

It provides a complete backend to your client app without the hassle that comes with it.

Key features


- ⚡ Instant backend with DB, REST API and Admin panel without any configuration
- 🧠 Smart SDK to import in your favorite JS front-end
- 🛠️ Essential features like Auth, Storage, Validation and Hooks

Forget about drag-and-drop visual builders


With CASE, you structure your data using TypeScript classes straight from your coding environment.

  1. ```js
  2. // entities/cat.entity.ts
  3. @Entity()
  4. export class Cat extends BaseEntity {
  5.   @Prop()
  6.   name: string

  8.   @Prop({
  9.     type: PropType.Date
  10.   })
  11.   birthDate: Date

  13.   @Prop({
  14.     type: PropType.Relation,
  15.     options: {
  16.       entity: Owner
  17.     }
  18.   })
  19.   owner: Owner
  20. }
  21. ```

Effortless integration in your client app


And allow the following code in your JS client built with your favorite stack: React, Svelte, Angular, Vue or any front-end. You can even use it in NodeJS.

  1. ```js
  2. import CaseClient from '@casejs/case-client'

  4. // Init SDK
  5. const cs = new CaseClient()

  7. // Get all cats with their owner
  8. const cats = await cs.from('cats').with(['owner']).find()

  10. // Filter cats.
  11. const cats = await cs
  12.   .from('cats')
  13.   .where('breed = siamese')
  14.   .andWhere('birthDate > 2020-01-01')
  15.   .find()

  17. // Create a new cat.
  18. const newCat = await cs.from('cats').create({
  19.   name: 'Milo',
  20.   age: 2
  21. })

  23. // Upload.
  24. const fileUrl: string = await cs.from('cats').addFile(file)

  26. // Login.
  27. await cs.login('users', 'user1@case.app', 'case')
  28. ```

Getting started


Prerequisites


- NodeJS (v16.14.0 or higher). The recommended version is 18.x.

Create your CASE project


Run the following on your terminal replacing my-case-app with your app's name:

  1. ```
  2. npx create-case-app my-case-app
  3. ```

Then serve the app locally:

  1. ```
  2. cd my-case-app
  3. npm start
  4. ```

🎉 Your backend is ready !


You can now:
- See your **Admin panel** at http://localhost:4000
- Use your **REST API** at http://localhost:4000/api

You can now go through the docs to build your next block.

Community & Resources


- Docs - Learn CASE features
- Discord - Come chat with the CASE community
- Dev.to - Stay tuned to CASE developments
- Github - Report bugs and share ideas to improve the product.

Contributors


Thanks to our first wonderful contributors !