Getting Started With
This is a quick start guide to get you up and running with Softkit. Softkit is a set of tools and services that help you build and run your software part of the business. It is designed to be used by developers to automate routing tasks and to help focus on building your product, and decrease the probability of tech debt from day one.
Main Features
- Softkit CLI - A CLI tool that helps you to create new services by generating code for you.
- Authentication and Authorization, Including configuration per tenant for SAML and OpenId Connect
- First class multi-tenancy support, with logical segregation
- Logging and Monitoring. Supported from the box providers:
- Localization
- Color Scheme - A cohesive and accessible color palette tailored for an optimal user experience.
- Typed Config Management
- Health Monitoring
- Test Standards and Utils
- Standardized Error Handling - following RFC7807
- Take responsibilities to support every library that we do use
- Automatic Swagger Open API documentation generation
- Automatic API client generation
- Support for multiple databases:
- Deploy & Publish - A set of tools and practices that helps you to manage your infrastructure and application configurations
- CI/CD - Automation for ci/cd setup
- Docker - Docker images for all services
- GitOps - A set of tools and practices that helps you to manage your infrastructure and application configurations using Git as a single source of truth
- Kubernetes - Kubernetes manifests for all services
- Terraform - Terraform manifests for all services
- Marketplace With Ready Made Services
- Library Documentation
- API Documentation
Quick Start
What you'll need
-
Node.js version v20 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
- We recommend to use NVM for installing and managing
Node.js versions. After installation, you can run
nvm install 20to install Node.js v20.
-
Docker version 20.10 or above
-
Docker Compose version 1.29 or above