Skip to content

Commit

Permalink
fix(ci): init linter checks
Browse files Browse the repository at this point in the history
  • Loading branch information
pahaz committed May 11, 2024
1 parent 1ff6c78 commit db3ec07
Show file tree
Hide file tree
Showing 12 changed files with 146 additions and 35 deletions.
1 change: 0 additions & 1 deletion .github/workflows/ci.build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ jobs:
- name: install packages
run: |
corepack enable
yarn init -2
yarn set version stable
yarn install
- name: BUILD
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/ci.linters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ jobs:
- name: install packages
run: |
corepack enable
yarn init -2
yarn set version stable
yarn install
- name: BUILD
run: yarn lint
- run: yarn format --check
- run: yarn lint
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
!.yarn/sdks
!.yarn/versions
yarn-error.log
yarn.lock
npm-debug.*

# mobile
Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ We use: Prisma, Apollo GraphQL

### Contents

* [Motivation & Features](#why)
* [Getting started](docs/getting-started.md)
* [Deploy](docs/deploy.md)
* [Contributing](docs/contributing.md)
- [Motivation & Features](#why)
- [Getting started](docs/getting-started.md)
- [Deploy](docs/deploy.md)
- [Contributing](docs/contributing.md)

## Why?

When you start a new project, you need a time-tested approach to development.
When you start a new project, you need a time-tested approach to development.
You need to prepare the basic structure of the project, implement registration and authorization.

If you are making a B2B solution, you need to implement roles and access rights and the possibility of invites.
Expand All @@ -27,7 +27,7 @@ You need to implement notifications, page templates, and internationalization su

Using a template, you don't have to spend hours choosing technologies and gluing them together.

The libraries used can be changed over time.
The libraries used can be changed over time.

Don't start by choosing a technology, start implement your key features!

Expand All @@ -37,15 +37,15 @@ You can use this project if you are going to launch a new startup or participate

## Features

* Auth flow
* Registration
* Authentication and Authorization
* Change password
* Reset password
* Organization entity
* Management of organization members
* Invite users
* Ant design based frontend
- Auth flow
- Registration
- Authentication and Authorization
- Change password
- Reset password
- Organization entity
- Management of organization members
- Invite users
- Ant design based frontend

Full list of features and requested features is found under [contributing.md](docs/contributing.md) and issues

Expand Down
4 changes: 2 additions & 2 deletions apps/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
All applications are stored here.
All applications are stored here.

You can use a microservice approach or a traditional monolith approach.
You can use a microservice approach or a traditional monolith approach.
But we strongly recommend separating your API from the front-end application.
12 changes: 6 additions & 6 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@

**Available CLI-commands:**

- `yarn lint` lint whole project <- this command runs on CI
- `yarn lint` lint whole project <- this command runs on CI

# Project features and feature requests.

- [x] Monorepo: packages and apps
- [x] Monorepo: requirements tree : /packages/* and /apps/* depends on /package.json
- [x] Monorepo: requirements tree : /packages/\* and /apps/\* depends on /package.json
- [x] Monorepo: reusable UI package example
- [ ] Monorepo: docs how to add app or package
- [x] TypeScript support
- [x] NextJs: init with SSR (app router) + the latest React
- [x] Antd: init Ant Design support with custom theme
- [ ] TypeScript support
- [ ] NextJs: init with SSR (app router) + the latest React
- [ ] Antd: init Ant Design support with custom theme
- [ ] CI: run tests
- [ ] CI: test build
- [ ] CI: linters
Expand Down Expand Up @@ -72,4 +72,4 @@
- [ ] Bull: scheduled tasks
- [ ] Logging
- [ ] DX: command to add new API Schema
- [ ] DX: command to add new Web and Api app
- [ ] DX: command to add new Web and Api app
2 changes: 1 addition & 1 deletion docs/deploy.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Deploy

TODO
TODO
8 changes: 4 additions & 4 deletions docs/links.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Learn

0. You should have a [basic knowledge](https://htmlacademy.org/courses/html-css-basics/intro/html) about [HTML/CSS](https://www.internetingishard.com/html-and-css/)
0. You should have a [basic knowledge](https://htmlacademy.org/courses/html-css-basics/intro/html) about [HTML/CSS](https://www.internetingishard.com/html-and-css/)
1. You should know [Modern JavaScript](https://javascript.info/)
2. You should know [GraphQL](https://graphql.org/)

Expand All @@ -23,6 +23,6 @@

# Philosophy

1) BACKEND: You write domain models and services on backend side (it's better if each service have only one action)
2) TESTS: TDD is matter! Tests should work parallel and independently! You should write tests in mind of extensibility (you don't need to rewrite the test if you add extra fields). You can run tests on a remote production API by URL or local development server!
3) STYLE: You should follow the common style or change the whole style everywhere (not only in your files)
1. BACKEND: You write domain models and services on backend side (it's better if each service have only one action)
2. TESTS: TDD is matter! Tests should work parallel and independently! You should write tests in mind of extensibility (you don't need to rewrite the test if you add extra fields). You can run tests on a remote production API by URL or local development server!
3. STYLE: You should follow the common style or change the whole style everywhere (not only in your files)
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@
"scripts": {
"build": "turbo build",
"dev": "turbo dev",
"start": "turbo start",
"lint": "turbo lint",
"format": "prettier --write \"**/*.{ts,tsx,md}\""
},
"devDependencies": {
"prettier": "^3.2.5",
"turbo": "^1.13.3"
},
"dependencies": {
Expand Down
4 changes: 2 additions & 2 deletions packages/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The internal packages are stored here.
The internal packages are stored here.

These can be UI libraries or auxiliary utilities.
These can be UI libraries or auxiliary utilities.
Everything that can be published in NPM, but is used inside the apps.
17 changes: 17 additions & 0 deletions turbo.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"$schema": "https://turbo.build/schema.json",
"globalDependencies": ["**/.env.*local"],
"pipeline": {
"build": {
"dependsOn": ["^build"],
"outputs": [".next/**", "!.next/cache/**"]
},
"lint": {
"dependsOn": ["^lint"]
},
"dev": {
"cache": false,
"persistent": true
}
}
}
95 changes: 95 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# This file is generated by running "yarn install" inside your project.
# Manual changes might be lost - proceed with caution!

__metadata:
version: 8
cacheKey: 10c0

"prettier@npm:^3.2.5":
version: 3.2.5
resolution: "prettier@npm:3.2.5"
bin:
prettier: bin/prettier.cjs
checksum: 10c0/ea327f37a7d46f2324a34ad35292af2ad4c4c3c3355da07313339d7e554320f66f65f91e856add8530157a733c6c4a897dc41b577056be5c24c40f739f5ee8c6
languageName: node
linkType: hard

"start-up-kit@workspace:.":
version: 0.0.0-use.local
resolution: "start-up-kit@workspace:."
dependencies:
prettier: "npm:^3.2.5"
turbo: "npm:^1.13.3"
languageName: unknown
linkType: soft

"turbo-darwin-64@npm:1.13.3":
version: 1.13.3
resolution: "turbo-darwin-64@npm:1.13.3"
conditions: os=darwin & cpu=x64
languageName: node
linkType: hard

"turbo-darwin-arm64@npm:1.13.3":
version: 1.13.3
resolution: "turbo-darwin-arm64@npm:1.13.3"
conditions: os=darwin & cpu=arm64
languageName: node
linkType: hard

"turbo-linux-64@npm:1.13.3":
version: 1.13.3
resolution: "turbo-linux-64@npm:1.13.3"
conditions: os=linux & cpu=x64
languageName: node
linkType: hard

"turbo-linux-arm64@npm:1.13.3":
version: 1.13.3
resolution: "turbo-linux-arm64@npm:1.13.3"
conditions: os=linux & cpu=arm64
languageName: node
linkType: hard

"turbo-windows-64@npm:1.13.3":
version: 1.13.3
resolution: "turbo-windows-64@npm:1.13.3"
conditions: os=win32 & cpu=x64
languageName: node
linkType: hard

"turbo-windows-arm64@npm:1.13.3":
version: 1.13.3
resolution: "turbo-windows-arm64@npm:1.13.3"
conditions: os=win32 & cpu=arm64
languageName: node
linkType: hard

"turbo@npm:^1.13.3":
version: 1.13.3
resolution: "turbo@npm:1.13.3"
dependencies:
turbo-darwin-64: "npm:1.13.3"
turbo-darwin-arm64: "npm:1.13.3"
turbo-linux-64: "npm:1.13.3"
turbo-linux-arm64: "npm:1.13.3"
turbo-windows-64: "npm:1.13.3"
turbo-windows-arm64: "npm:1.13.3"
dependenciesMeta:
turbo-darwin-64:
optional: true
turbo-darwin-arm64:
optional: true
turbo-linux-64:
optional: true
turbo-linux-arm64:
optional: true
turbo-windows-64:
optional: true
turbo-windows-arm64:
optional: true
bin:
turbo: bin/turbo
checksum: 10c0/0382cc88f65a6690e97d30a6ad5d9b9ede7705f5f57edea27629408b166eff4a5938824746ce2cbcd50d2b64ebdbd359160e2cbe009f0bfd6f144997f9f6705b
languageName: node
linkType: hard

0 comments on commit db3ec07

Please sign in to comment.