acid-info
/
development-guidelines
mirror of https://github.com/acid-info/development-guidelines.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update technology-stack.md 

Minor grammar/wording edits
(Some use cases missing on page)
This commit is contained in:
0xbathang 2022-12-08 15:01:39 +01:00 committed by GitHub
parent c0a6fd9c9f
commit 5ef6402ace
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
technology-stack.md
View File

@ -1,6 +1,6 @@
- [Introduction](#introduction)
- [Languages](#languages)
- [Typescript](#typescript)
- [TypeScript](#typescript)
- [Use Cases](#use-cases)
- [CSS/SCSS](#cssscss)
- [Use Cases](#use-cases-1)
@ -21,15 +21,15 @@
- [Vercel](#vercel)
- [Use Cases](#use-cases-7)
## Introduction
This document will introduce the programming languages, frameworks, tools, and services we prefer to build and ship software with. It also provides links to tools and guides to help you implement [contribution rules](/contribution-rules.md) and a [branching strategy](/branching-strategy.md) when setting up a new project.
This document will introduce the programming languages, frameworks, tools and services with which we prefer to build and ship software. It also provides links to tools and guides to help you implement [contribution rules](/contribution-rules.md) and a [branching strategy](/branching-strategy.md) when setting up a new project.
Choosing the right tech stack depends on multiple factors, such as the software type, functionalities, and requirements. It's impossible to cover all possibilities, nor is it our intention. But we encourage contributors to choose their stack as close as possible to what is covered here, so that other contributors would be familiar with it. Also, this will allow us to prepare guides and tools for implementing our development workflow once and use them in multiple projects.
Choosing the right tech stack depends on multiple factors, such as the software type, functionalities and requirements. It's impossible to cover all possibilities, nor is it our intention. However, we encourage contributors to align their stack as closely as possible to that described below so that other contributors are familiar with it. Also, this allows us to minimize the time spent preparing guides and tools for implementing our development workflow as documentation will be used for multiple projects.
## Languages
### Typescript
Most of the software we make is web-based or web-related, so we use Javascript as it's currently the dominant language in the web ecosystem. Besides, its ecosystem enables us to build almost any other type of software.
Not being a type-safe language, Javascript increases the chance of runtime errors and makes it extremely hard to read and maintain the project as it or the team working on it gets bigger. We prefer Typescript over Javascript because it has solved these issues, ensuring that we deliver safer software.
### TypeScript
Since most of the software we make is web-based or web-related, we use JavaScript as it's currently the dominant language in the web ecosystem. Besides, its ecosystem enables us to build almost any other type of software.
Not being a type-safe language, JavaScript increases the chance of runtime errors, making it extremely difficult to read and maintain the project as it, or the team working on it, gets bigger. We prefer TypeScript over JavaScript because it has solved these issues, ensuring that we deliver safer software.
#### Use Cases
@ -45,7 +45,7 @@ Not being a type-safe language, Javascript increases the chance of runtime error
### Next.js
[Next.js](https://nextjs.org/) is an open-source [React](https://reactjs.org/) framework created by [Vercel](http://vercel.com/). We build frameworks on top of it to speed up our website development process.
#### Use Cases
- A framework that empowers Logos brands to build websites under the design system of Logos. See [here](https://github.com/acid-info/logos-site-builder).
- A framework that empowers Logos brands to build websites under the design system of Logos (see [here](https://github.com/acid-info/logos-site-builder))
### NestJS
#### Use Cases
@ -54,7 +54,7 @@ Not being a type-safe language, Javascript increases the chance of runtime error
[Docusaurus](https://github.com/facebook/docusaurus) is an open-source [React](https://reactjs.org/) framework created by Facebook for building documentation websites, which supports i18n, versioning, custom pages, MDX documents, customized themes, etc.
#### Use Cases
- Create highly customized documentation websites for Logos business units. (see [codex.storage](https://codex.storage), [here](http://github.com/acid-info/logos-documentation-website-template), and [here](https://github.com/acid-info/logos-docusaurus-plugins))
- Create highly customized documentation websites for Logos business units (see [codex.storage](https://codex.storage), [here](http://github.com/acid-info/logos-documentation-website-template) and [here](https://github.com/acid-info/logos-docusaurus-plugins))
## CI/CD
### GitHub Actions
@ -63,8 +63,8 @@ Not being a type-safe language, Javascript increases the chance of runtime error
## Cloud Platforms
### Vercel
We only intend to use Vercel for demo and test cases, but we're also temporarily deploying multiple Logos brands' websites on it.
We only intend to use Vercel for demo and test cases, but we're also temporarily deploying multiple Logos brand websites on it.
#### Use Cases
- Quickly deploy websites for demo & test cases
- Setup CI/CD pipelines and deploy Logos brands websites ([vac.dev](http://vac.dev/), [waku.org](https://waku.org/), [codex.storage](https://codex.storage))
- Quickly deploy websites for demo and test cases
- Setup CI/CD pipelines and deploy Logos brand websites ([vac.dev](http://vac.dev/), [waku.org](https://waku.org/), [codex.storage](https://codex.storage))