Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/between-freedom-and-space/web-backend-facade
Web-Client facade adapter for Mono-Backend
https://github.com/between-freedom-and-space/web-backend-facade
docker express express-js facade facade-pattern javascript json npm routing swagger
Last synced: 23 days ago
JSON representation
Web-Client facade adapter for Mono-Backend
- Host: GitHub
- URL: https://github.com/between-freedom-and-space/web-backend-facade
- Owner: Between-Freedom-and-Space
- License: apache-2.0
- Created: 2022-05-12T20:45:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-25T11:19:23.000Z (over 1 year ago)
- Last Synced: 2023-04-25T12:36:38.770Z (over 1 year ago)
- Topics: docker, express, express-js, facade, facade-pattern, javascript, json, npm, routing, swagger
- Language: JavaScript
- Homepage:
- Size: 1.76 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Web-backend-facade
Frontend backend facade of monolith. Allows to make one request to get all the data for the page.
Performs only the function of combining several responses into one.
## Features:
* JavaScript's frameworks and infrastructure:
1. **Node.js**
2. **Express.js**
3. **dotenv**
* Docker
1. Ability to run the application in any environment
2. Easy integration into Kubernetes
* Simplicity
* CI/CD
## Structure:
The project consists of two main modules and util packages.
### First module is [api](/src/api):
Contains all endpoints to Mono-Backend.
Usually you need token and body from frontend.
### Second module is [pages](/src/pages):
Contains all routings for Facade and controllers for each page.
Usually controllers implements aggregate logic of Mono-Backend endpoints.
### Visualisation:
```shell
├── api (All endpoints to Mono-Backend)
│ ├── auth-api.js
│ ├── comment-reactions-api.js
│ ├── comments-api.js
│ ├── popular-api.js
│ ├── post-reactions-api.js
│ ├── posts-api.js
│ ├── profiles-api.js
│ └── tags-api.js
├── app (Facade application)
├── assets (Static assets)
├── common (Helpers and custom libraries)
└── pages (Page routings and controllers)
├── about-service
├── authentication
├── comment
├── home
├── post
├── post-create
├── profile
├── profile-settings
├── profile-subscribers
├── profile-subscriptions
├── registration
└── search
```
## How to launch:
* Create `.env` file in the root project/
* As default way you can use `npm run env`
* Make setup with `npm install`
* Make up server with `npm run dev`
## Git Flow:
For our developers and managers we use [YouTrack](https://www.jetbrains.com/youtrack/) as project management tool.
So the **common** flow is:
1. Checkout `develop` branch
2. Create a new branch with pattern: `feature/` or `bugfix/`
3. Add feature code, write tests and check performance
4. Commit changes with next description: `: Your short description`
5. Make `git push` and create pull request to `develop` branch. Add some description.
6. Wait until reviewers approve
7. Merge and deploy to testing stage.
**Release** flow:
1. Checkout `develop` branch
2. Create a new branch with pattern: `release/v`
3. Create pull request to `main` branch
4. Wait until reviewers approve
5. Deploy release to production stage and merge the pull request
**Hotfix** flow:
1. Create a new branch with pattern: `hotfix/`
2. Add code and commit changes
3. Create pull request and wait approve
4. Merge
If you want to add some functionality, and **you are not in our team**:
1. Create a new branch from `develop` with pattern: `contribution/`
2. Add all code, write tests and check performance
3. Commit changes with next description: `CONTRIBUTION: Your short description`
4. Make `git push` and create pull request to `develop` branch. Add complete description.
5. Wait until reviewers approve
6. Pull request will be automatically merged
#### Created and Powered by Ferum-bot.
#### Co-author JUSSIAR