Skip to content

Commit 10af1bb

Browse files
committed
Adds tech stack
Refs #20
1 parent 50fcd20 commit 10af1bb

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

README.dev.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,24 @@
11
# Developer notes
22

3-
We're developing the wireframes and interaction designs over at [https://www.figma.com/](https://www.figma.com/).
43

5-
`cffinit` is a Single Page App written in [TypeScript](https://www.typescriptlang.org/) using [Vue.js v3](https://v3.vuejs.org/) and [its composition API](https://v3.vuejs.org/api/composition-api.html).
64

7-
The notes about technology choices, design, personas can be found in [project-docs/](project-docs/) folder.
5+
## Technology stack
6+
7+
- [Single Page App](https://en.wikipedia.org/wiki/Single-page_application): The `cffinit` app will be a SPA. So app feels like a native app and no server-side code needs to run.
8+
- [https://www.figma.com/](https://www.figma.com/): A vector graphics and prototyping editor used to developed the wireframes and interaction designs.
9+
- [npm CLI](https://docs.npmjs.com/cli/v7): Package manager command line interface shipped with NodeJS.
10+
- [TypeScript](https://www.typescriptlang.org/): Typed JavaScript language used for lowering maintenance cost.
11+
- [Vue.js v3](https://v3.vuejs.org/): A frontend JS framework for building user interfaces.
12+
- [Vue.js Composition API](https://v3.vuejs.org/guide/composition-api-introduction.html): Is style of writing UI components to group logical concerns like state management.
13+
- [Quasar](https://quasar.dev/): A UI framework, a group of UI components, that follow [Material design guidelines](https://material.io/design) to make a coherent/pleasing user interface.
14+
- [Quasar CLI](https://quasar.dev/quasar-cli): Build and test infrastructure.
15+
- [GitHub pages](https://pages.github.com/): Hosting of static HTML files. The build app (in `docs` folder) is deployed on it.
16+
- [Husky](https://typicode.github.io/husky/#/): Automaticly runs checks before pushing changes to GitHub.
17+
- [Jest](https://jestjs.io/): Testing framework to run unit tests and perform test assertions.
18+
- [highlight.js]: To syntax highlight the YAML formatted file.
19+
- [ESLint](https://eslint.org/): To get constistent code style and prevent errors the industry standard linter ESLint is used.
20+
21+
The notes about how we came to this technology stack, design and personas can be found in [project-docs/](project-docs/) folder.
822

923
## Clone the repository
1024

@@ -71,3 +85,4 @@ You can also use the Majestic web interface to run the unit tests in your browse
7185

7286
```shell
7387
npm run test:unit:ui
88+
```

0 commit comments

Comments
 (0)