Skip to content

Commit

Permalink
Make “installation” a container for sub menus
Browse files Browse the repository at this point in the history
  • Loading branch information
kordwarshuis committed Jan 27, 2025
1 parent 418210a commit b3f3b7d
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 79 deletions.
Original file line number Diff line number Diff line change
@@ -1,84 +1,8 @@
---
sidebar_position: 1
sidebar_position: 5
---

# Installation

Get started by **creating a new Spec-Up-T installation**.



## Create a new Spec-Up-T installation

### Let's create

Make sure you are in the directory where you want to install Spec-Up-T. A new subdirectory will be created with **your chosen name**, and the Spec-Up-T files will be placed in this subdirectory.

```bash
npx create-spec-up-t my-spec-up-t-website
```

*my-spec-up-t-website* can be anything you want it to be, that will **your chosen name** (however, it is recommended to not use spaces or special characters in directory names).

You can also omit the last part:

```bash
npx create-spec-up-t
```

If you omit `my-spec-up-t-website`, a default directory name, namely `spec-up-t-boilerplate,` is used.

Sometimes, you want to force the latest version to be installed. Then you can do the following:

```bash
npx create-spec-up-t@latest my-spec-up-t-website
```

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. It should work on any operating system (not tested yet).

### Result

You should now have a directory called `my-spec-up-t-website` (or `spec-up-t-boilerplate` if you did not specify a name) with a subdirectory called `spec/`. You will find markdown files and another subdirectory, `terms-definitions` containing markdown files containing some sample content.

What you don't have yet is the following:

- a `docs` directory with a sample `index.html` file (which is the actual specification file that is the goal of it all).

How to do this, go to the [Command Line Menu](../user-interface-overview/command-line-menu.md).

### Add repo to Github

You should push your new specification (i.e. the sample content) to a GitHub repo.

These are the steps to take:

#### Edit `specs.json`

Change this entry in `specs.json`:

```json
"source": {
"host": "github",
"account": "blockchainbird",
"repo": "spec-up-t-starter-pack"
}
```

to the correct information:

```json
"source": {
"host": "github",
"account": "your-account",
"repo": "your-repo"
}
```

These are the host (GitHub), your GitHub account name, and the repo name of the repo you are about to push.

#### Commit and Push repo to GitHub

Now, commit your changes and push the repo to GitHub. Use the command line or your preferred way to do this.
# Different Operating Systems

## Difference between MacOS and Windows or Linux instructions

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/github-token.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 90
sidebar_position: 4
---

# GitHub Personal Access Token (PAT)
Expand Down
8 changes: 8 additions & 0 deletions docs/getting-started/installation/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Installation",
"position": 1,
"link": {
"type": "generated-index",
"description": "Installation."
}
}
49 changes: 49 additions & 0 deletions docs/getting-started/installation/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
sidebar_position: 1
---

# Local Installation

Get started by **creating a new Spec-Up-T installation**.



## Create a new Spec-Up-T installation

### Let's create

Make sure you are in the directory where you want to install Spec-Up-T. A new subdirectory will be created with **your chosen name**, and the Spec-Up-T files will be placed in this subdirectory.

```bash
npx create-spec-up-t my-spec-up-t-website
```

*my-spec-up-t-website* can be anything you want it to be, that will **your chosen name** (however, it is recommended to not use spaces or special characters in directory names).

You can also omit the last part:

```bash
npx create-spec-up-t
```

If you omit `my-spec-up-t-website`, a default directory name, namely `spec-up-t-boilerplate,` is used.

Sometimes, you want to force the latest version to be installed. Then you can do the following:

```bash
npx create-spec-up-t@latest my-spec-up-t-website
```

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. It should work on any operating system (not tested yet).

### Result

You should now have a directory called `my-spec-up-t-website` (or `spec-up-t-boilerplate` if you did not specify a name) with a subdirectory called `spec/`. You will find markdown files and another subdirectory, `terms-definitions` containing markdown files containing some sample content.

What you don't have yet is the following:

- a `docs` directory with a sample `index.html` file (which is the actual specification file that is the goal of it all).

How to do this, go to the [Command Line Menu](../../user-interface-overview/command-line-menu.md).

Now [let's get this thing on GitHub](push-to-github.md).

0 comments on commit b3f3b7d

Please sign in to comment.