Skip to content

Navigation Menu

Sign in
Sign up

Repository files navigation

⛺ Campkit

Build serverless Node.js microservices fast.


serverless node awesome

Intro

This project is under heavy development.

Campkit is an opinionated Node.js framework for building serverless microservices. It makes a bunch of decisions so that you don't have to. Currently it works best with aws lambda and the serverless framework.

Quick start

npx @campkit/cli create someServiceName

Features

  • small & simple
  • define your service as a class annotating it to provide configuration
  • path and query parameters are automatically injected into the class method
  • service discovery built in (coming soon)

Works with provider

  • Amazon Web Service - Lambda

At a glance

import { RestController, Get, Post } from "@campkit/rest";
@RestController({
 basePath: "/user"
})
export class UserController {
 @Get({
 path: "/:id" // -> GET user/1234
 })
 getUserById({ params }) {
 return {
 id: params.id
 };
 }
 @Post({
 path: "/" // -> POST user/
 })
 createUser({ body }){
 return {
 user: body
 };
 }

Basic microservice

// index.js
import { CampkitFactory } from "@campkit/core";
import { UserApp } from "./user.app";
export const handler = async (event, context) => {
 return await CampkitFactory.create(UserApp, { event, context });
};
// user.app.js
import { App } from "@campkit/core";
import { UserController } from "./user.controller";
@App({
 name: "user",
 restController: UserController
})
export class UserApp {
}
// user.controller.js
import { RestController, Get, Post } from "@campkit/rest";
@RestController({
 basePath: "/user"
})
export class UserController {
 @Get({
 path: "/:id" // -> GET user/1234
 })
 getUser({ params }) {
 return {
 message: "get user by id",
 id: params.id
 };
 }
 @Post({
 path: "/" // -> POST user/
 })
 createUser({ body }){
 return {
 message: "create a user",
 userInfo: body
 };
 }

About

Build serverless Node.js microservices fast

Topics

Resources

Contributing

Stars

125 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages

AltStyle によって変換されたページ (->オリジナル) /