Lucasnhso / sygnus

Node micro-framework to create fast cruds apis with express and prisma

Welcome to sygnus 👋

An library to create fast cruds apis with express and prisma

Install

npm install sygnus

🚀 Usage

You can use sygnus-cli to generate automatically new sygnus module

Recommended Folder Structure

├─ src
│ ├─ database
│ │ ├─ prisma
│ │ ├─ prismaClient.ts
│ ├─ controllers
│ ├─ useCases
│ ├─ repositories
│ │
│ ├─ routes.ts
│ └─ server.ts

Example Repository

import { ResourceRepository } from 'sygnus'
import prismaClient from '../database/prismaClient'

export default class ExampleRepository extends ResourceRepository {
  constructor() {
    super(prismaClient, 'user')
  }
}

Example UseCase

import ExampleRepository from '../repositories/ExampleRepository'
import { ResourceUseCase } from 'sygnus'

export default class ExampleUseCase extends ResourceUseCase<ExampleRepository> {
  constructor() {
    super(new ExampleRepository())
  }
}

Example Controller

import ExampleUseCase from '../useCases/ExampleUseCase'
import { ResourceController } from 'sygnus'

export default class ExampleController extends ResourceController {
  constructor() {
    super(new ExampleUseCase())
  }
}

Author

👤 Lucas Oliveira

• Github: @lucasnhso
• LinkedIn: @lucas-h-oliveira

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!