1128.01 - Fix Broken Links (Getting Started): Update installation guide.

This commit is contained in:
Philleep Florence
2021-01-06 02:57:10 -05:00
parent cd52f7dba2
commit f731b08b95
2 changed files with 65 additions and 34 deletions

View File

@@ -1,15 +1,19 @@
# Installing from CLI
## 1. Confirm Minimum Requirements are Met
> A command line interface (CLI) is a text-based user interface (UI) used to view and manage computer files. Common CLI clients are [Windows Terminal](https://en.wikipedia.org/wiki/Windows_Terminal) and [MacOS Terminal](https://en.wikipedia.org/wiki/Terminal_(macOS)).
> [Learn More about CLI](/reference/command-line-interface)
**The only requirements for Directus is an actively maintained version of
[Node.js](https://nodejs.org/en/about/releases/).** Currently that is v10+, however in April 2021, node v10 will leave
## 1. Confirm the Minimum Requirements are met
**The only language or script requirement for Directus is an actively maintained version of
[Node.js](https://nodejs.org/en/about/releases/).**
Currently that is v10+, however in April 2021, node v10 will leave
_Maintenance Long-Term Support (LTS)_ status, and node v12+ will become the new minimum requirement.
### Databases
Directus currently supports the following databases, with our minimum version being based on each vendor's official
support/LTS.
Directus currently supports the following databases, with our minimum version being based on each vendor's official support/LTS.
| Database | Version |
| ------------- | ------- |
@@ -28,12 +32,22 @@ Variants In addition to the databases above, other variants are also supported,
## 2. Create a Project
Navigate to the directory where you wish to create a new Directus project.
The new project and directory will be created inside the current directory.
Create a new Directus project by running the following npm command.
<!-- prettier-ignore-start -->
::: warning
To avoid installation issues, do not name your project _directus_.
:::
<!-- prettier-ignore-end -->
```bash
npx create-directus-project my-project
```
_my-project_ will also be the name of the new Directus project directory.
<!-- prettier-ignore-start -->
::: warning
Except for SQLite, the database must already be running before creating your Directus
@@ -43,8 +57,25 @@ project.
## 3. Start your Project
To start Directus, simply run the following command in your project directory.
To start Directus, navigate to the project directory, _my-project_.
```bash
cd my-project
```
Run the following command in your project directory.
```bash
npx directus start
```
## 4. View your Project
The default port used by Directus is 8055.
To view your project locally, enter `http://localhost:8055` in your browser.
<!-- prettier-ignore-start -->
::: tip
You can confirm the port by looking for the message in your _terminal_ or _cli client_:
**Server started at port 8055**
:::
<!-- prettier-ignore-end -->

View File

@@ -4,45 +4,45 @@ Welcome to the Directus documentation.
## Getting Started
Novice Oriented. For a platform intro and installation.
Novice Oriented. For a platform introdusction and installation.
- [Introduction](#)
- [Support](#)
- [Contributing](#)
- [Backing Directus](#)
- [Introduction](/getting-started/introduction)
- [Support](/getting-started/support)
- [Contributing](/getting-started/contributing)
- [Backing Directus](/getting-started/backing-directus)
## Concepts
Learning Oriented. For understanding the platfom.
Learning Oriented. For understanding the platform.
- [Platform Overview](#)
- [App Overview](#)
- [App Extensions](#)
- [Activity & Versions](#)
- [Files & Thumbnails](#)
- [Internationalization](#)
- [Relationships](#)
- [Users, Roles & Permissions](#)
- [Platform Overview](/concepts/platform-overview)
- [App Overview](/concepts/app-overview)
- [App Extensions](/concepts/app-extensions)
- [Activity & Versions](/concepts/activity-and-versions)
- [Files & Thumbnails](/concepts/files-and-thumbnails)
- [Internationalization](/concepts/internationalization)
- [Relationships](/concepts/relationships)
- [Users, Roles & Permissions](/concepts/users-roles-and-permissions)
## Guides
Problem Oriented. Follow along with steps while working.
- [Collections](#)
- [Fields](#)
- [Presets](#)
- [Projects](#)
- [Roles & Permissions](#)
- [Users](#)
- [Webhooks](#)
- [White-Labeling](#)
- [Collections](/guides/collections)
- [Fields](/guides/fields)
- [Presets](/guides/presets)
- [Projects](/guides/projects)
- [Roles & Permissions](/guides/roles-and-permissions)
- [Users](/guides/users)
- [Webhooks](/guides/webhooks)
- [White-Labeling](/guides/white-labeling)
## Reference
Information Oriented. Look up info and specs while working.
Information Oriented. Look up info and specificationss while working.
- [Command Line Interface](#)
- [Environment Variables](#)
- [Error Codes](#)
- [Filter Rules](#)
- [Item Objects](#)
- [Command Line Interface](/reference/command-line-interface)
- [Environment Variables](/reference/environment-variables)
- [Error Codes](/reference/error-codes)
- [Filter Rules](/reference/filter-rules)
- [Item Objects](/reference/item-objects)