https://github.com/bamlab/conceptor
https://github.com/bamlab/conceptor
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bamlab/conceptor
- Owner: bamlab
- Created: 2020-04-01T16:35:18.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-06T03:57:52.000Z (over 3 years ago)
- Last Synced: 2024-04-15T00:00:03.787Z (about 2 years ago)
- Language: TypeScript
- Size: 663 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Conceptor
Conceptor is a visualizing tool to help you apprehend technical design in you software development process.
It implements the concept of [CRC Cards](http://agilemodeling.com/artifacts/crcModel.htm) and mainly focuses on helping you highlight the concepts of components ["responsibilities"](https://medium.com/@severinperez/writing-flexible-code-with-the-single-responsibility-principle-b71c4f3f883f) and "collaboration" between them.
## Prerequisites
Supported project languages:
- Javascript
- Typescript
## Usage
### 1. 📝 Document your components
Use [jsdoc](https://jsdoc.app/) to add the following header to your files:
```javascript
/**
* @name MyComponent
* @responsibility This component handles on thing
* @responsibility This component also handles this other thing
**/
```
Note that the `@name` tag is optional. If not provided, the component name will be infered from the filename.
### 2. ▶️ Run the "Conceptor"
- 💻 Open the Command Palette: `Shift+CMD+P`
- ⌨️ Type: `Conceptor`
- ☕️ Wait for it...
- 🎉Enjoy Technical Design 😁
## [Release Notes](./CHANGELOG.md)
---
### Issues ?
Should you encounter any issue or require some new feature, feel free to post an issue [here](https://github.com/bamlab/conceptor/issues), we'll be happy to take a look at it 😉.
**🙌 Enjoy!**