Nebula Logix Starter Kit

This is a downloadable & installable AWS production-ready AI-enabled package that serves essentially as a Software As A Service (SaaS), that users/clients can setup quickly in their AWS environment.

Components

• cli/ directory to generate a full-fledged deployable application with a variety of modules and functionalities to choose from.
• templates/ directory containing the base NestJS application template.
• modules/ directory for the modules options.

Features

• NestJS framework for building scalable and maintainable server-side applications.
• AWS Lambda integration for serverless deployment.
• Pre-configured TypeScript support.
• Sample API endpoint to demonstrate functionality.

Prerequisites

• Node.js (version 14 or higher)
• npm (version 6 or higher)
• AWS CLI configured with your credentials

Setup

Navigate to the 'cli' directory

$ RUN cd cli
$ RUN npm install
$ RUN nebula create <app-name>

Deployment

Navigate to the app directory

$ RUN cd <app-name>
$ RUN serverless deploy --config infra/api/serverless.yml
$ COPY the "ServiceEndpoint" value from the terminal output and update the NEXT_PUBLIC_API_URL of the .env.local of the ui directory
$ RUN npm run deploy

$ Navigate to the "WebsiteURL" of the buckets on the terminal output

Teardown

Navigate to the app directory

$ RUN cd <app-name>
$ RUN npm run teardown

Common Errors

❌ Not a nebula project
Usage: Run nebula command only in specified locations

❌ Unknown command
Available commands
1. nebula create <app-name>
2. nebula add service <service-name>
3. nebula list services

❌ Services directory not found

❌ Modules directory not found

Example of the folder structure of the starter kit and an nlx app generated.
The ui directory contains the NextJS React App

The infra contains the api gateway, s3 buckets and other associated infrastructure setup.

The services contains the individual service modules as determined by the user.

The core has the database, authentication and other related features.

├── cli
│   ├── dist
│   ├── nebula.json
│   ├── package-lock.json
│   ├── package.json
│   ├── src
│   ├── templates
│   └── tsconfig.json
├── nlx
│   ├── core
│   ├── infra
│   ├── nebula.json
│   ├── package.json
│   ├── serverless-compose.yml
│   ├── services
│   ├── tsconfig.json
│   └── ui
└── README.md