Skip to content

Commit aee5d65

Browse files
adrumadrum
committed
added quick start
1 parent 7ebb2dd commit aee5d65

6 files changed

Lines changed: 140 additions & 0 deletions

File tree

‎starlight/src/sidebars/v1.mjs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ export const sidebarV1 = [
77
label: "Getting Started",
88
items: [
99
{ label: "Introduction", slug: `${base}/getting-started` },
10+
{ label: "Quick Start", slug: `${base}/getting-started/quick-start` },
1011
{ label: "Demo Application", slug: `${base}/getting-started/demo-application` },
1112
{ label: "Upgrade Guide", slug: `${base}/getting-started/upgrade-guide` },
1213
{ label: "Recommended Middleware", slug: `${base}/getting-started/recommended-middleware` },

‎starlight/src/sidebars/v2.mjs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ export const sidebarV2 = [
55
label: "Getting Started",
66
items: [
77
{ label: "Introduction", slug: `${base}/getting-started` },
8+
{ label: "Quick Start", slug: `${base}/getting-started/quick-start` },
89
{ label: "Demo Application", slug: `${base}/getting-started/demo-application` },
910
{ label: "Upgrade Guide", slug: `${base}/getting-started/upgrade-guide` },
1011
{ label: "Recommended Middleware", slug: `${base}/getting-started/recommended-middleware` },

‎starlight/src/sidebars/v3.mjs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ export const sidebarV3 = [
55
label: "Getting Started",
66
items: [
77
{ label: "Introduction", slug: `${base}/getting-started` },
8+
{ label: "Quick Start", slug: `${base}/getting-started/quick-start` },
89
{ label: "Demo Application", slug: `${base}/getting-started/demo-application` },
910
{ label: "Upgrade Guide", slug: `${base}/getting-started/upgrade-guide` },
1011
{ label: "Recommended Middleware", slug: `${base}/getting-started/recommended-middleware` },

‎v1/getting-started/quick-start.mdx‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Quick Start
3+
---
4+
5+
import V1EOLWarning from "/snippets/v1-eol-warning.mdx";
6+
7+
<V1EOLWarning />
8+
9+
Use the following steps to get up and running with a fresh project using [InertiaCore](https://github.com/kapi2289/InertiaCore). If you would like to install InertiaCore into an existing project, please refer to the [server-side setup](/v1/installation/server-side-setup) instructions.
10+
11+
## Prerequisites
12+
13+
- .NET 6.0 or higher
14+
- Node.js 18.0 or higher
15+
16+
## New Project
17+
18+
You can use the `create-inertiacore` starter kit to scaffold a new project:
19+
20+
```bash
21+
npm create inertiacore@latest
22+
```
23+
24+
You will be asked to enter a project name and to select the front-end library you want to use — React, Vue, or Svelte.
25+
26+
### Run the Project
27+
28+
Once the project has been created, you can run it using the following commands.
29+
30+
In one terminal, start the .NET development server:
31+
32+
```bash
33+
dotnet run
34+
```
35+
36+
In another terminal, start the Vite development server for your front-end:
37+
38+
```bash
39+
cd ClientApp
40+
npm run dev
41+
```
42+
43+
You can then access the application at `http://localhost:5266` (or `https://localhost:7266` if you are using HTTPS).
44+
45+
## Existing Project
46+
47+
If you are looking to install InertiaCore into an existing project, please refer to the [server-side setup](/v1/installation/server-side-setup) and [client-side setup](/v1/installation/client-side-setup) instructions.

‎v2/getting-started/quick-start.mdx‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Quick Start
3+
---
4+
5+
import V2UpgradeWarning from "/snippets/v2-upgrade-warning.mdx";
6+
7+
<V2UpgradeWarning />
8+
9+
Use the following steps to get up and running with a fresh project using [InertiaCore](https://github.com/kapi2289/InertiaCore). If you would like to install InertiaCore into an existing project, please refer to the [server-side setup](/v2/installation/server-side-setup) instructions.
10+
11+
## Prerequisites
12+
13+
- .NET 6.0 or higher
14+
- Node.js 18.0 or higher
15+
16+
## New Project
17+
18+
You can use the `create-inertiacore` starter kit to scaffold a new project:
19+
20+
```bash
21+
npm create inertiacore@latest
22+
```
23+
24+
You will be asked to enter a project name and to select the front-end library you want to use — React, Vue, or Svelte.
25+
26+
### Run the Project
27+
28+
Once the project has been created, you can run it using the following commands.
29+
30+
In one terminal, start the .NET development server:
31+
32+
```bash
33+
dotnet run
34+
```
35+
36+
In another terminal, start the Vite development server for your front-end:
37+
38+
```bash
39+
cd ClientApp
40+
npm run dev
41+
```
42+
43+
You can then access the application at `http://localhost:5266` (or `https://localhost:7266` if you are using HTTPS).
44+
45+
## Existing Project
46+
47+
If you are looking to install InertiaCore into an existing project, please refer to the [server-side setup](/v2/installation/server-side-setup) and [client-side setup](/v2/installation/client-side-setup) instructions.

‎v3/getting-started/quick-start.mdx‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Quick Start
3+
---
4+
5+
Use the following steps to get up and running with a fresh project using [InertiaCore](https://github.com/kapi2289/InertiaCore). If you would like to install InertiaCore into an existing project, please refer to the [server-side setup](/v3/installation/server-side-setup) instructions.
6+
7+
## Prerequisites
8+
9+
- .NET 6.0 or higher
10+
- Node.js 18.0 or higher
11+
12+
## New Project
13+
14+
You can use the `create-inertiacore` starter kit to scaffold a new project:
15+
16+
```bash
17+
npm create inertiacore@latest
18+
```
19+
20+
You will be asked to enter a project name and to select the front-end library you want to use — React, Vue, or Svelte.
21+
22+
### Run the Project
23+
24+
Once the project has been created, you can run it using the following commands.
25+
26+
In one terminal, start the .NET development server:
27+
28+
```bash
29+
dotnet run
30+
```
31+
32+
In another terminal, start the Vite development server for your front-end:
33+
34+
```bash
35+
cd ClientApp
36+
npm run dev
37+
```
38+
39+
You can then access the application at `http://localhost:5266` (or `https://localhost:7266` if you are using HTTPS).
40+
41+
## Existing Project
42+
43+
If you are looking to install InertiaCore into an existing project, please refer to the [server-side setup](/v3/installation/server-side-setup) and [client-side setup](/v3/installation/client-side-setup) instructions.

0 commit comments

Comments
 (0)