https://github.com/thesoftwarehouse/rad-modules
A set of reusable dockerized components and serverless functions
https://github.com/thesoftwarehouse/rad-modules
Last synced: about 1 year ago
JSON representation
A set of reusable dockerized components and serverless functions
- Host: GitHub
- URL: https://github.com/thesoftwarehouse/rad-modules
- Owner: TheSoftwareHouse
- License: mit
- Created: 2020-07-04T17:22:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-26T16:41:06.000Z (over 3 years ago)
- Last Synced: 2025-04-06T20:23:12.915Z (about 1 year ago)
- Language: TypeScript
- Size: 4.41 MB
- Stars: 15
- Watchers: 13
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
Current travis build:
##
### **Security** module to handle users and users policy,
---
### What’s under the hood?
RAD Modules framework is written in TypeScript, based on Express and Awilix (DI container) development model.
RAD Modules provide many features. The list includes (but not limited to):
- Quick scaffolding
Create actions, routes, and models - right from the CLI using Plop micro-generator framework.
- Dependency injection
- Static code analysis
- User management and administration tools
- Generic Filter — a component which allows users to create their own search conditions
- Generic REST API
- Keycloak/OpenID Integration
---
### Configuration
After checkout of a repository, please perform the following steps in exact sequence:
1. Copy docker-compose.override
```
$ cp docker-compose.override.yml.dist docker-compose.override.yml
```
2. Run watch `npm start`
3. Run security service `npm run security`
4. Run production integration tests `npm run security-integration`
5. Open your browser and go to the swagger api docs: [http://localhost:50050/api-docs/](http://localhost:50050/api-docs/)
6. On the swagger page, generate an access token via endpoint `/api/public/auth/login` or `/api/users/login` good luck! 🔥
---
### How to check if everything works?
1. If you forgot to run builder run `npm run watch`
2. Run `docker-compose up security`
3. Open your browser and go to: [http://localhost:50050/api-docs/](http://localhost:50050/api-docs/)
You should see the swagger panel and request in terminal
---
### Dev setup
This app is fully dockerized, so in order to use it you have to have docker and docker-compose installed. What's more you need to have npm in order to run npm scripts.
1. In order to run specific container run:
```
docker-compose up security
```
2. In order to watch files for dev purpose type:
```
npm run watch
```
3. If you need to close all containers run:
```
npm run down
```
---
### Code generation
We're using Plop for routes, models, actions, commands and handlers generation.
```
npm run plop
```
---
### Code style
We're using Prettier and ESLint to keep code clean. In order to reformat/check code run:
```
npm run lint
npm run format
```
---
### Migrations
Migrations should be stored inside migrations directory of specific service.
Easiest way to create a migration is to generate it from entity/ies. Run inside specific service directory:
```
npm run generate-migration --
```
This should generate a migration for all connected entities.
---
### Documentation
If you want to read more about RAD modules or check examples of how to set it up, please read the [documentation](https://thesoftwarehouse.github.io/rad-modules-docs/docs/index.html)
---
### ReDoc
If you want to check all endpoint definitions of each service, please check RAD modules [Redoc](https://thesoftwarehouse.github.io/rad-modules-api-docs/)
---
### **Issues:**
If you notice any issues while using, let as know on **[github](https://github.com/TheSoftwareHouse/rad-modules/issues)**.
Security issues, please sent on email
---
### **You may also like our other projects:**
- **[RAD Modules Tools](https://github.com/TheSoftwareHouse/rad-modules-tools)**
- **[Boilerplate API](https://github.com/TheSoftwareHouse/express-boilerplate)**
- **[Serverless Boilerplate](https://github.com/TheSoftwareHouse/serverless-boilerplate)**
- **[Kakunin](https://github.com/TheSoftwareHouse/Kakunin)**
- **[Babelsheet-js](https://github.com/TheSoftwareHouse/babelsheet-js)**
- **[Fogger](https://github.com/TheSoftwareHouse/fogger)**
---
### **About us:**
---
### License
[](https://raw.githubusercontent.com/TheSoftwareHouse/rad-modules/main/LICENSE)
This project is licensed under the terms of the [MIT license](/LICENSE).
