answer/ui
Li Shuailing c7c293cdac Merge branch 'feat/ui-1.0.4' into 'test'
fix(Question): Optimise the display of check information for Question related form fields

See merge request opensource/answer!432
2023-02-03 03:39:10 +00:00
..
build del index.html 2023-02-01 18:20:42 +08:00
public feat(version): Add the version number to the index html header 2023-01-29 11:30:05 +08:00
scripts chore: merge important refactor from origin main 2022-11-14 10:42:45 +08:00
src Merge branch 'feat/ui-1.0.4' into 'test' 2023-02-03 03:39:10 +00:00
template add html meta generator 2023-01-30 15:49:53 +08:00
.browserslistrc initial commit 2022-09-27 17:59:05 +08:00
.editorconfig initial commit 2022-09-27 17:59:05 +08:00
.env.development refactor(env): migrate env config by .env file 2022-11-10 16:37:03 +08:00
.env.production refactor(env): migrate env config by .env file 2022-11-10 16:37:03 +08:00
.eslintignore initial commit 2022-09-27 17:59:05 +08:00
.eslintrc.js feat: add timeline router 2022-11-23 15:21:36 +08:00
.gitignore ggpush 2023-02-01 18:18:11 +08:00
.lintstagedrc.json ci(linting): remove unnecessary `git add` command during linting 2022-11-22 17:35:40 +08:00
.npmrc refactor(package.json): purge dependencies 2022-11-14 09:55:56 +08:00
.prettierrc.json Fix windows endOfLine error 2022-11-01 15:16:21 +08:00
README.md doc(ui): Update the description of the front-end i18n directory 2023-01-12 11:16:33 +08:00
commitlint.config.js chore(ui): add commit lint 2022-11-21 18:21:00 +08:00
config-overrides.js fix(Personal): Remove the background color of all Tabs on personal home page 2022-12-21 10:11:44 +08:00
package.json chore(ui): add dependency library 2023-01-30 14:22:18 +08:00
pnpm-lock.yaml chore(ui): add dependency library 2023-01-30 14:22:18 +08:00
static.go add template 2022-11-29 18:02:42 +08:00
tsconfig.json chore: merge important refactor from origin main 2022-11-14 10:42:45 +08:00

README.md

Answer

Answer is a modern Q&A community application

To learn more about the philosophy and goals of the project, visit Answer.

⚙️ Prerequisites

pnpm is required by building the Answer project. To installing the pnpm tools with below commands:

corepack enable
corepack prepare pnpm@v7.12.2 --activate

With Node.js v16.17 or newer, you may install the latest version of pnpm by just specifying the tag:

corepack prepare pnpm@latest --activate

🔨 Development

clone the repo locally and run following command in your terminal:

$ git clone git@github.com:answerdev/answer.git answer
$ cd answer/ui
$ pnpm install
$ pnpm start

now, your browser should already open automatically, and autoload http://localhost:3000. you can also manually visit it.

👷 Workflow

when cloning repo, and run pnpm install to init dependencies. you can use project commands below:

  • pnpm start run Answer web locally.
  • pnpm build build Answer for production
  • pnpm lint lint and fix the code style

🌍 I18n(Multi-language)

If you need to add or edit a language entry, just go to the /i18n/en_US.yaml file, all front-end language entries are placed under the ui field.

If you would like to help us with the i18n translation, please visit Answer@Crowdin

💡 Project instructions

.
├── cmd
├── configs
├── docs
├── i18n
      ├── en_US.yaml (basic language file)
      ├── i18n.yaml (language list)
├── internal
├── ...
└── ui (front-end project starts here)
      ├── build (built results directory, usually without concern)
      ├── public (html template for public)
      ├── scripts (some scripting tools on front-end project)
      ├── src (almost all front-end resources are here)
            ├── assets (static resources)
            ├── common (project information/data defined here)
            ├── components (all components of the project)
            ├── hooks (all hooks of the project)
            ├── i18n (Used only to initialize the front-end i18n tool)
            ├── pages (all pages of the project)
            ├── router (Project routing definition)
            ├── services (all data api of the project)
            ├── stores (all data stores of the project)
            ├── utils (all utils of the project)

🤝 Contributing

Fix Bug

If you find a bug, please don't hesitate to submit an issue to us. If you can fix it, please include a note with your issue submission. If it is a bug definitely, you can submit your PR after we confirm it, which will ensure you don't do anything useless.

Code Review & Comment

In our development, some codes are not logical we know. If you find it, please don't hesitate to submit PR to us. In the same way, some function has no comment. We would appreciate it if you could help us supplement it.

Translation

All our translations are placed in the i18n directory.

  1. If you find that the corresponding key in the language you are using does not have a translation, you can submit your translation.
  2. If you want to submit a new language translation, please add your language to the i18n.yaml file.

Features or Plugin

  1. We developed the features for the plan based on the roadmap. If you are suggestions for new functions, please confirm whether they have been planned.
  2. Plugins will be available in the future, so stay tuned.

📱Environment Support

Edge
Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
last 2 versions last 2 versions last 2 versions last 2 versions

Built with