Skip to content

Commit

Permalink
docs: update home content
Browse files Browse the repository at this point in the history
  • Loading branch information
Romakita committed Nov 30, 2024
1 parent 613150c commit 7e6a0f3
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 18 deletions.
10 changes: 5 additions & 5 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
// https://vitepress.dev/guide/custom-theme
import {DefaultTheme} from "@tsed/vitepress-theme";
import type {Theme} from "vitepress";
import {h} from "vue";
import HomeBanner from "@tsed/vitepress-theme/organisms/home/HomeBanner.vue";
import HomePartners from "@tsed/vitepress-theme/organisms/home/HomePartners.vue";
import HomeBody from "@tsed/vitepress-theme/organisms/home/HomeBody.vue";
import HomePartners from "@tsed/vitepress-theme/organisms/home/HomePartners.vue";
import HomeTabsTerminal from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabsTerminal.vue";
import HomeTabTerminalBun from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalBun.vue";
import HomeTabTerminalNpm from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalNpm.vue";
import HomeTabTerminalYarn from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalYarn.vue";
import HomeTabTerminalPnpm from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalPnpm.vue";
import HomeTabTerminalBun from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalBun.vue";
import HomeTabTerminalYarn from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalYarn.vue";
import type {Theme} from "vitepress";
import {h} from "vue";
import "./style.css";

export default {
Expand Down
4 changes: 4 additions & 0 deletions docs/.vitepress/theme/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@
padding-right: 0;
}


.box a {
color: var(--vp-c-brand-1);
}
23 changes: 14 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home
meta:
- name: description
content: Ts.ED is a modern Node.js framework built with TypeScript. It offers a flexible structure with a fast learning curve, specifically designed to improve the developer experience. Ts.ED provides numerous decorators and guidelines to make your code more readable and less error-prone. It supports various platforms and tools, including Node.js/Bun.js, Express.js/Koa.js, CLI, and serverless architectures (e.g., AWS).
- name: keywords
content: ts.ed express koa aws cli di rest graphql typescript node.js bun.js javascript native ESM decorators jsonschema class models

hero:
name: "Ts.ED"
text: "A TypeScript Framework on top of Express/Koa.js."
tagline: "Build your awesome server-side application"
text: "A modern framework written in TypeScript"
tagline: "A flexible framework with a fast learning curve, designed to enhance the developer experience"
actions:
- theme: brand
text: What is Ts.ED?
Expand All @@ -18,24 +23,24 @@ hero:
link: https://github.com/sponsors/Romakita

features:
- title: Rest API
- title: Multi-platform
icon: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-server"><rect width="20" height="8" x="2" y="2" rx="2" ry="2"/><rect width="20" height="8" x="2" y="14" rx="2" ry="2"/><line x1="6" x2="6.01" y1="6" y2="6"/><line x1="6" x2="6.01" y1="18" y2="18"/></svg>
details: Create your Rest API easily and create different version paths of your API compliant with <a class="home-link" href="/tutorials/swagger.html">OpenSpec</a> and <a class="home-link" href="/docs/model.html">JsonSchema</a>.
details: Easily build your server-side application using Express.js, Koa.js, CLI, or serverless platforms (e.g., AWS). It supports both Node.js and Bun.js runtimes. Learn more <a class="home-link" href="/introduction/capabilities.html">here</a>.
- title: Configuration
icon: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-bolt"><path d="M21 16V8a2 2 0 0 0-1-1.73l-7-4a2 2 0 0 0-2 0l-7 4A2 2 0 0 0 3 8v8a2 2 0 0 0 1 1.73l7 4a2 2 0 0 0 2 0l7-4A2 2 0 0 0 21 16z"/><circle cx="12" cy="12" r="4"/></svg>
details: Don't waste your time with configuration, the server is preconfigured to start quickly! Try our <a class="home-link" href="/getting-started/#installation">CLI</a>.
details: Stop wasting time on configuration—your application comes preconfigured for a fast start! Try our <a class="home-link" href="/introduction/getting-started.html">CLI</a>.
- title: Plugins
icon: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-unplug"><path d="m19 5 3-3"/><path d="m2 22 3-3"/><path d="M6.3 20.3a2.4 2.4 0 0 0 3.4 0L12 18l-6-6-2.3 2.3a2.4 2.4 0 0 0 0 3.4Z"/><path d="M7.5 13.5 10 11"/><path d="M10.5 16.5 13 14"/><path d="m12 6 6 6 2.3-2.3a2.4 2.4 0 0 0 0-3.4l-2.6-2.6a2.4 2.4 0 0 0-3.4 0Z"/></svg>
details: Choose between different plugins to create your own stack.
details: Explore a variety of <a href="/plugins/index.html">plugins</a> to customize your application and build the perfect stack tailored to your needs. You can even create your own plugins to extend functionality further.
- title: Class based
icon: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-gem"><path d="M6 3h12l4 6-10 13L2 9Z"/><path d="M11 3 8 9l4 13 4-13-3-6"/><path d="M2 9h20"/></svg>
details: Define class as <a class="home-link" href="/docs/controllers.html">Controller</a>, <a class="home-link" href="/docs/model.html">Model</a>, <a class="home-link" href="/docs/providers.html">Providers</a> (DI), <a class="home-link" href="/docs/pipes.html">Pipes</a>, <a class="home-link" href="/docs/middlewares.html">Middlewares</a>, etc...
details: Define classes as <a class='home-link' href='/docs/controllers.html'>Controllers</a>, <a class='home-link' href='/docs/model.html'>Models</a>, <a class='home-link' href='/docs/providers.html'>Providers (DI)</a>, <a class='home-link' href='/docs/pipes.html'>Pipes</a>, and more, with JSON Schema and OpenAPI at the core of the framework.
- title: Decorators
icon: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-paintbrush"><path d="m14.622 17.897-10.68-2.913"/><path d="M18.376 2.622a1 1 0 1 1 3.002 3.002L17.36 9.643a.5.5 0 0 0 0 .707l.944.944a2.41 2.41 0 0 1 0 3.408l-.944.944a.5.5 0 0 1-.707 0L8.354 7.348a.5.5 0 0 1 0-.707l.944-.944a2.41 2.41 0 0 1 3.408 0l.944.944a.5.5 0 0 0 .707 0z"/><path d="M9 8c-1.804 2.71-3.97 3.46-6.583 3.948a.507.507 0 0 0-.302.819l7.32 8.883a1 1 0 0 0 1.185.204C12.735 20.405 16 16.792 16 15"/></svg>
details: A lot of decorators are provided to structure your code and define routes and methods.
details: Leverage a wide range of <a href='/introduction/create-your-first-controller.html'>decorators</a> to structure your code, define routes, and implement methods with ease.
- title: Testing
icon: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-flask-conical"><path d="M10 2v7.527a2 2 0 0 1-.211.896L4.72 20.55a1 1 0 0 0 .9 1.45h12.76a1 1 0 0 0 .9-1.45l-5.069-10.127A2 2 0 0 1 14 9.527V2"/><path d="M8.5 2h7"/><path d="M7 16h10"/></svg>
details: To test or not to test? isn't a question. Ts.ED embeds some features to test your code! <a class="home-link" href="/docs/testing.html">See more</a>.
details: Testing is not optional—it's essential! Ts.ED includes built-in features to make testing your code simple and efficient. <a class='home-link' href='/docs/testing.html'>Learn more</a>.
frameworks:
- title: Node.js
href: https://nodejs.org/
Expand Down
11 changes: 7 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,15 @@

<hr />

> A Node.js and TypeScript Framework on top of Express. It provides a lot of decorators and guidelines to write your code.
## What it is

Ts.ED is a Node.js and TypeScript Framework on top of Express/Koa.js. Ts.ED is a framework on top of Express/Koa to write your application with TypeScript (or ES6).
It provides a lot of decorators and guideline to make your code more readable and less error-prone.
Ts.ED is a modern Node.js framework built with TypeScript. It offers a flexible structure with a fast learning curve, specifically designed to improve the developer experience. Ts.ED provides numerous decorators and guidelines to make your code more readable and less error-prone. It supports various platforms and tools, including Node.js/Bun.js, Express.js/Koa.js, CLI, and serverless architectures (e.g., AWS).

- Multi-platform: Easily build your server-side application using Express.js, Koa.js, CLI, or serverless platforms (e.g., AWS). It supports both Node.js and Bun.js runtimes. Learn more <a class="home-link" href="https://tsed.dev/introduction/capabilities.html">here</a>.
- Configuration: Stop wasting time on configuration—your application comes preconfigured for a fast start! Try our <a class="home-link" href="https://tsed.dev/introduction/getting-started.html">CLI</a>.
- Decorators: Use a wide range of decorators to structure your code, define routes, and implement methods with ease. Learn more <a class="home-link" href="https://tsed.dev/introduction/decorators.html">here</a>.
- Class-based: Define classes as <a class='home-link' href='http://tsed.dev/docs/controllers.html'>Controllers</a>, <a class='home-link' href='http://tsed.dev/docs/model.html'>Models</a>, <a class='home-link' href='http://tsed.dev/docs/providers.html'>Providers (DI)</a>, <a class='home-link' href='http://tsed.dev/docs/pipes.html'>Pipes</a>, and more, with JSON Schema and OpenAPI at the core of the framework.
- Testing: Testing is not optional—it's essential! Ts.ED includes built-in features to make testing your code simple and efficient. Learn more <a class="home-link" href="https://tsed.dev/docs/testing.html">here</a>.

## Features

Expand Down

0 comments on commit 7e6a0f3

Please sign in to comment.