diff --git a/README.md b/README.md index 9c78cec1..c55bec24 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,31 @@ # Web Client of voce.chat -

- -

+
+ +
+

+

+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/privoce/vocechat-web/issues) ![GitHub issues](https://img.shields.io/github/issues-raw/Privoce/vocechat-web) ![GitHub](https://img.shields.io/github/license/privoce/vocechat-web) ![GitHub top language](https://img.shields.io/github/languages/top/privoce/vocechat-web) -- Powered by React & Redux Toolkit -- Typescript supported -- PWA supported +
-## Refs +- 🎉 Powered by React & Redux Toolkit +- ✅ Typescript +- 📦 PWA +- 📢 Notification + +## Docs + +https://doc.voce.chat/en-us/ + +## Preview + +- Official Online Demo: https://privoce.voce.chat/ +- Demo API Docs (Swagger): https://dev.voce.chat/api/swagger -- preview demo: https://privoce.voce.chat/ - design: https://www.figma.com/file/EHnNr53kNmDWgUT86It6CH/UI -- backend APIs: https://dev.voce.chat/api/swagger - text editor: https://plate.udecode.io/docs/installation - markdown editor: https://nhn.github.io/tui.editor/latest/ - redux: [@reduxjs/toolkit](https://redux-toolkit.js.org/introduction/getting-started) @@ -22,10 +33,24 @@ ## Local Development +- `git clone https://github.com/Privoce/vocechat-web vocechat-web` + +- `cd vocechat-web & yarn install` + +- `yarn start` + +- Open `localhost:3009` + +### Tools Recommended + - [VS Code](https://code.visualstudio.com/) Editor Recommended - VS Code plugins: - - dbaeumer.vscode-eslint: ESLint - - esbenp.prettier-vscode: Prettier - - components.vscode-styled-components: Syntax highlighting for styled-components - - jonkwheeler.styled-components-snippets: Styled-Components Snippets for VSCode - - dsznajder.es7-react-js-snippets:Extensions for React, React-Native and Redux in JS/TS with ES7+ syntax + - [dbaeumer.vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint): ESLint + - [esbenp.prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode): Prettier + - [styled-components.vscode-styled-components](https://marketplace.visualstudio.com/items?itemName=styled-components.vscode-styled-components): Syntax highlighting for styled-components + - [jonkwheeler.styled-components-snippets](https://marketplace.visualstudio.com/items?itemName=jonkwheeler.styled-components-snippets): Styled-Components Snippets for VSCode + - [dsznajder.es7-react-js-snippets](https://marketplace.visualstudio.com/items?itemName=dsznajder.es7-react-js-snippets): Extensions for React, React-Native and Redux in JS/TS with ES7+ syntax + +## License + +[GPL v3](https://github.com/Privoce/vocechat-web/blob/main/LICENSE)