Skip to content

Commit 8f543de

Browse files
committed
Refactor code structure for improved readability and maintainability
1 parent 7cda491 commit 8f543de

14 files changed

Lines changed: 31 additions & 39 deletions

File tree

docs/.vitepress/config.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,22 @@ export default defineConfig({
77
title: "Arkstack",
88
description: "Simple, Starter Kit for Node.js applications built with TypeScript",
99
head: [
10-
['link', { rel: 'icon', href: '/banner.png' }],
10+
['link', { rel: 'icon', href: '/logo.png' }],
1111
['meta', { name: 'viewport', content: 'width=device-width, initial-scale=1.0' }],
1212
['meta', { name: 'description', content: 'Simple, Starter Kit for Node.js applications built with TypeScript' }],
1313
['meta', { name: 'keywords', content: 'API, Web, Node.js, TypeScript, Starter Kit' }],
1414
['meta', { name: 'author', content: 'Toneflix' }],
1515
['meta', { property: 'og:title', content: 'Arkstack' }],
1616
['meta', { property: 'og:description', content: 'Simple, Starter Kit for Node.js applications built with TypeScript' }],
17-
['meta', { property: 'og:image', content: '/banner.png' }],
17+
['meta', { property: 'og:image', content: '/logo.jpg' }],
1818
['meta', { property: 'og:url', content: 'https://arkstack.github.io/arkstack/' }],
1919
['meta', { name: 'twitter:card', content: 'summary_large_image' }],
2020
['meta', { name: 'twitter:title', content: 'Arkstack' }],
2121
['meta', { name: 'twitter:description', content: 'Simple, Starter Kit for Node.js applications built with TypeScript' }],
22-
['meta', { name: 'twitter:image', content: '/banner.png' }]
22+
['meta', { name: 'twitter:image', content: '/logo.jpg' }]
2323
],
2424
themeConfig: {
25+
logo: '/logo.png',
2526
// https://vitepress.dev/reference/default-theme-config
2627
nav: [
2728
{ text: 'Home', link: '/' },
@@ -35,7 +36,7 @@ export default defineConfig({
3536
text: 'Guide',
3637
items: [
3738
{ text: 'Getting Started', link: '/guide/getting-started' },
38-
{ text: 'Api Reference', link: '/api' },
39+
{ text: 'API Reference', link: '/api' },
3940
]
4041
},
4142
{

docs/.vitepress/theme/style.css

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
*
2525
* The soft color must be semi transparent alpha channel. This is crucial
2626
* because it allows adding multiple "soft" colors on top of each other
27-
* to create a accent, such as when having inline code block inside
27+
* to create an accent, such as when having inline code block inside
2828
* custom containers.
2929
*
3030
* - `default`: The color used purely for subtle indication without any
@@ -51,7 +51,7 @@
5151

5252
--vp-c-brand-1: var(--vp-c-indigo-1);
5353
--vp-c-brand-2: var(--vp-c-indigo-2);
54-
--vp-c-brand-3: var(--vp-c-indigo-3);
54+
--vp-c-brand-3: var(#f5a624);
5555
--vp-c-brand-soft: var(--vp-c-indigo-soft);
5656

5757
--vp-c-tip-1: var(--vp-c-brand-1);
@@ -94,14 +94,14 @@
9494
--vp-home-hero-name-color: transparent;
9595
--vp-home-hero-name-background: -webkit-linear-gradient(
9696
120deg,
97-
#bd34fe 30%,
98-
#41d1ff
97+
#f5a624 30%,
98+
#011627
9999
);
100100

101101
--vp-home-hero-image-background-image: linear-gradient(
102102
-45deg,
103-
#bd34fe 50%,
104-
#47caff 50%
103+
#f5a624 50%,
104+
#011627 50%
105105
);
106106
--vp-home-hero-image-filter: blur(44px);
107107
}
@@ -128,12 +128,3 @@
128128
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
129129
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
130130
}
131-
132-
/**
133-
* Component: Algolia
134-
* -------------------------------------------------------------------------- */
135-
136-
.DocSearch {
137-
--docsearch-primary-color: var(--vp-c-brand-1) !important;
138-
}
139-

docs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Arkstack kits use `@arkstack/console` to run common commands.
4444

4545
## Built-in Commands
4646

47-
Run commands through the Arkstack CLI entry (for example `npx arch`).
47+
Run commands through the Arkstack CLI entry (for example `npx ark`).
4848

4949
### `route:list`
5050

docs/guide/getting-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ $ yarn dev
8484

8585
## Useful Commands
8686

87-
- `npx arch dev` - run in development mode
88-
- `npx arch build` - build for production
89-
- `npx arch` - run Arkstack console commands
87+
- `npx ark dev` - run in development mode
88+
- `npx ark build` - build for production
89+
- `npx ark` - run Arkstack console commands
9090
- `pnpm lint` - run lint checks
9191

9292
## Full vs Lean

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ hero:
66
name: "Arkstack"
77
tagline: Framework-agnostic TypeScript backend starter kits.
88
image:
9-
src: /banner.png
10-
alt: Arkstack banner image
9+
src: /logo.jpg
10+
alt: Arkstack logo
1111
actions:
1212
- theme: brand
1313
text: Get Started

docs/public/logo.jpg

57 KB
Loading

docs/public/logo.png

23.9 KB
Loading

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
"test:coverage": "vitest run --coverage",
1111
"test:integration": "vitest run tests/integration",
1212
"build:packages": "pnpm -r --filter \"@arkstack/*\" build",
13-
"version:packages": "pnpm -r --filter \"@arkstack/*\" version:patch",
14-
"publish:packages": "pnpm version:packages && pnpm -r --filter \"@arkstack/*\" publish --access public --no-git-checks",
13+
"version:packages": "pnpm -r --filter \"@arkstack/*\" version:patch && git add . && git commit -m \"chore: bump package versions\"",
14+
"publish:packages": "pnpm version:packages && pnpm -r --filter \"@arkstack/*\" publish --access public",
1515
"dev": "tsdown --silent",
1616
"build": "NODE_ENV=production tsdown",
1717
"cmd": "tsx src/core/commands/index.ts",

packages/common/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@arkstack/common",
3-
"version": "0.1.0",
3+
"version": "0.1.1",
44
"type": "module",
55
"description": "Common package for Arkstack providing common implementations of core Arkstack features such as routing, middleware, and database integration.",
66
"repository": {
@@ -36,4 +36,4 @@
3636
"dependencies": {
3737
"detect-port": "^2.1.0"
3838
}
39-
}
39+
}

packages/console/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@arkstack/console",
3-
"version": "0.1.0",
3+
"version": "0.1.1",
44
"type": "module",
55
"description": "Console package for Arkstack providing console-specific implementations of core Arkstack features such as routing, middleware, and database integration.",
66
"repository": {
@@ -33,7 +33,7 @@
3333
"access": "public"
3434
},
3535
"bin": {
36-
"arch": "./dist/index.js"
36+
"ark": "./dist/index.js"
3737
},
3838
"exports": {
3939
".": {

0 commit comments

Comments
 (0)