Skip to content

Commit b251b3c

Browse files
authored
Update README.dev.md
1 parent 9ef81ee commit b251b3c

1 file changed

Lines changed: 15 additions & 20 deletions

File tree

README.dev.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,15 @@
22

33
If you are looking for user documentation, go [here](README.md).
44

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-
- [Figma](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. Combines well with Vue.js, Quasar and jest.
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](https://highlightjs.org/): 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.
22-
235
## Prerequisites
246

257
- Relevant issues:
268
- ...
279
- Hardware requirements
2810

11+
- [npm CLI](https://docs.npmjs.com/cli/v7): Package manager command line interface shipped with NodeJS.
12+
13+
2914
## Code editor
3015

3116
1. Do we need an editor plugin?
@@ -149,5 +134,15 @@ Make a [release on GitHub](https://github.com/citation-file-format/cff-initializ
149134

150135
## References
151136

152-
- Links to documentation or tutorials related to
153-
technologies/tools we use in the project
137+
Links to documentation or tutorials related to technologies/tools we use in the project are shown below. The notes about how we came to this technology stack, design and personas can be found in [project-docs/](project-docs/) folder.
138+
139+
- [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.
140+
- [Figma](https://www.figma.com/): A vector graphics and prototyping editor used to developed the wireframes and interaction designs.
141+
- [TypeScript](https://www.typescriptlang.org/): Typed JavaScript language used for lowering maintenance cost.
142+
- [Vue.js v3](https://v3.vuejs.org/): A frontend JS framework for building user interfaces.
143+
- [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.
144+
- [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.
145+
- [GitHub pages](https://pages.github.com/): Hosting of static HTML files. The build app (in `docs` folder) is deployed on it.
146+
- [Husky](https://typicode.github.io/husky/#/): Automaticly runs checks before pushing changes to GitHub.
147+
- [Jest](https://jestjs.io/): Testing framework to run unit tests and perform test assertions.
148+
- [ESLint](https://eslint.org/): To get constistent code style and prevent errors the industry standard linter ESLint is used.

0 commit comments

Comments
 (0)