https://github.com/mbc-net/mbc-cqrs-serverless-doc

https://github.com/mbc-net/mbc-cqrs-serverless-doc

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/mbc-net/mbc-cqrs-serverless-doc
• Owner: mbc-net
• License: mit
• Created: 2024-08-28T11:31:41.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-10-25T01:04:53.000Z (3 months ago)
• Last Synced: 2024-10-25T06:52:50.807Z (3 months ago)
• Language: TypeScript
• Size: 1.39 MB
• Stars: 0
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
![MBC CQRS serverless framework](https://mbc-net.github.io/mbc-cqrs-serverless-doc/img/mbc-cqrs-serverless.png)

# MBC CQRS serverless documentation

This website serves as the official documentation for [the MBC CQRS Serverless Framework](https://github.com/mbc-net/mbc-cqrs-serverless). It provides comprehensive information and resources to help developers understand and effectively utilize the framework.

### Installation

```

$ npm install

```

### Local Development

```

$ npm run start:watch

or

$ npm run start:watch {{country-code}}

```

This command starts a local development server. Most changes are reflected live without having to restart the server.

### Build

```

$ npm run build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Serve

```

$ npm run serve

```

After the build command, you can run a local server that will serve your website in build folder.

### Contributing

#### Support more language

1. Append country code to `i18n.locales` in docusaurus.config.ts.

2. Edit the content using the translation JSON file in the `i18n/{{country-code}}` folder

#### Write documentation

1. Run command `npm run start:watch {{country-code}}`

2. Create .md file in docs/ and write with placeholder

3. Edit sidebar.ts file. For more information, please follow this guide: https://docusaurus.io/docs/sidebar/items

4. Update the JSON for translation.

5. Run command `npm run build` and `npm run serve`: build static website and serve website in local

6. Check result.

We can summary the contributing process as the bellow image:



  



Note: Extract the theme translation JSON file with command: `npm run write-translations -- --locale {{country-code}}`

## License

Copyright © 2024, Murakami Business Consulting, Inc. https://www.mbc-net.com/

This project and sub projects are under the MIT License.