@link-loom/sdk
v7.2.11
Published
Core functionality for Loom projects to ensure quick setup and easy updates across multiple projects.
Downloads
52
Maintainers
Readme
loom-sdk
Another Node.js Server framework to create microservices or huge monoliths.
Features
- Open Api specification.
- Cron functions to execute code in intervals
- Cached functions to save concurrent data, you can upgrade to Redis.
- CLI tool to quickly create new views and API routes.
- Authentication middlewares.
- Cookies management.
- Tons of utilities to cypher data, search, handle responses, generate automatic IDs and so on.
- Own logs management to handle errors or queue messages.
- Multiple database engine handle, only you need to write your datasource.
- Isolated core code to be upgraded more easily.
- API Rest routes handling.
- Entity models specification.
- Event-driven architecture to communicate another services or frontend clients.
Install SDK project
Step 1. Install Loom to easily manage files and project
npm install --save @link-loom/sdk
Create project
Step 1. Install Loom to easily manage files and project
npm install -g @link-loom/cli
Step 2. Create a project with cli tool and follow instructions
link-loom -n name-of-project
Install dependencies
Step 1. Install the npm dependencies
npm install
Configure your environment variables - old-fashion
- Go to ./config folder
- Copy template.json file
- Change new file name to default.json
- Change all configurations you need
Configure your environment variables - Better way
- Go to Veripass
- Create a free account
- Create your organization, project and app
- Get a Developer API Key
- Setup all your environment variables
- Return to your project
- Setup your API Key and Veripass URL into your SO environment variables
Run
npm run
Documentation
Service docs
API Playground
Navigate to:
http://localhost:3601/open-api.playground
Warning: If you change your default port, you need to change in the previous route
Open Api
http://localhost:3601/open-api.json
Warning: If you change your default port, you need to change in the previous route
Framework docs
For all docs you need go to Wiki in this project.
https://github.com/link-loom/loom-sdk/wiki
License
The code is available under the GNU GENERAL PUBLIC LICENSE.