20 lines
1.6 KiB
Text
20 lines
1.6 KiB
Text
|
import { Meta } from '@storybook/addon-docs/blocks';
|
||
|
|
|
||
|
|
<Meta title="Chatwoot/Introduction" />
|
||
|
|
|
||
|
|
# Welcome to Chatwoot styleguide
|
||
|
|
|
||
|
|
Chatwoot as an opensource project is growing every day. New features are getting added in every release. The number of contributors who are actively contributing to the project is also increasing. It has become a necessity to create a standard guideline to make the contribution experience easier. This style guide resides as a central repository for the best practices we follow, a set of recommended approaches and the design guidelines/components we use.
|
||
|
|
|
||
|
|
Anyone willing to contribute to Chatwoot is encouraged to read this style guide. This style guide is also open source. If you feel that there are rooms for improvement, feel free to raise an issue or a pull request to the repository.
|
||
|
|
|
||
|
|
Through this style guide we intent to create a document which can be used across the repositories in the organization and build a design system for the project.
|
||
|
|
|
||
|
|
The document would split into 3 major sections
|
||
|
|
|
||
|
|
- **Design**: This section would contain the design choices and the documentation for the components built using these design choices.
|
||
|
|
|
||
|
|
- **Frontend**: Our frontend is built on [Vue.js](https://vuejs.org/). We follow [Airbnb guidelines for Javascript](https://github.com/airbnb/javascript) and there are a couple of choices we made in structuring the code. All those would be defined in this section.
|
||
|
|
|
||
|
|
- **Backend**: Our backend is written on [Ruby on Rails](https://rubyonrails.org/). This section would cover the architectural patterns we have been following so far.
|