From d7827ba24b5721d61db5d2ca847944825efd47c7 Mon Sep 17 00:00:00 2001 From: Esther Agbaje <53586167+estheragbaje@users.noreply.github.com> Date: Tue, 30 Jan 2024 10:44:21 +0000 Subject: [PATCH] Fix NPM Quickstart Guide (#21234) Co-authored-by: Pascal Jufer --- docs/getting-started/quickstart.md | 74 ++++++++++++++++++++---------- 1 file changed, 49 insertions(+), 25 deletions(-) diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 01aa13901aa61..f7f28de4c1849 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -17,54 +17,78 @@ readTime: 7 min read == Directus Cloud -Create and login to your [Directus Cloud account](https://directus.cloud). +1. Create and login to your [Directus Cloud account](https://directus.cloud) -The very first time you log in to your Cloud Account, you will be prompted to create a Team. Each Directus Cloud Project -exists within the scope of one Team. They allow you to organize Team Members, Projects and Project Billing as desired. + The very first time you log in to your Cloud Account, you will be prompted to create a Team. Each Directus Cloud + Project exists within the scope of one Team. They allow you to organize Team Members, Projects and Project Billing as + desired. -Create a new project - once started, it should take around 90 seconds for the Cloud Project to created. During this -time, a link will be sent to the email associated with your Cloud Account. The email will contain your Project URL as -well as an email and password to login. If you used GitHub to create your account, this will be your GitHub email. +2. Create a new project -Login to your new project using the URL in your email inbox or on your Directus Cloud Dashboard. + Once started, it should take around 90 seconds for the Cloud Project to created. During this time, a link will be + sent to the email associated with your Cloud Account. The email will contain your Project URL as well as an email and + password to login. If you used GitHub to create your account, this will be your GitHub email. -_Learn more about Directus Cloud Projects in our [User Guide](/user-guide/cloud/projects)._ +3. Access your new project + + Login to your new project using the URL in your email inbox or on your Directus Cloud Dashboard. + +Learn more about Directus Cloud Projects in our [User Guide](/user-guide/cloud/projects). == Docker Installation -You will need [Docker](https://docs.docker.com/get-docker/) installed and running on your machine. +1. Initialize and start a new Directus project -Open up your terminal and run the following command: + You will need [Docker](https://docs.docker.com/get-docker/) installed and running on your machine. -``` -docker run \ --p 8055:8055 \ --e KEY=replace-with-random-value \ --e SECRET=replace-with-random-value \ -directus/directus -``` + Open up your terminal and run the following command: -The initial admin email address and password will be shown in the terminal. Directus should now be available at -http://localhost:8055 or http://127.0.0.1:8055. + ```shell + docker run \ + -p 8055:8055 \ + -e KEY=replace-with-random-value \ + -e SECRET=replace-with-random-value \ + directus/directus + ``` -_Learn more about self-hosting Directus in our [Self-Hosted Quickstart](/self-hosted/quickstart)._ +2. Access your new project + + The initial admin email address and password will be shown in the terminal. Directus should now be available at + http://localhost:8055 or http://127.0.0.1:8055. + +Learn more about self-hosting Directus in our [Self-Hosted Quickstart](/self-hosted/quickstart). == NPM Installation -You can initialize a new Directus project using the CLI command: `npm init directus-project@latest`. +1. Initialize a new Directus project using the CLI -Follow prompts to configure your database and create your first admin user. + Replace `` with the name you want to use for the project directory. -To start Directus locally, run `npx directus start`. + ```shell + npm init directus-project@latest + ``` -Running Directus without Docker may result in errors as a result of environment-specific characteristics. In such a -case, make sure you have the required system dependencies for `isolated-vm`, `sharp`, and `argon2` installed. + Follow the prompts to configure your database and create your first admin user. + +2. Start your new project + + Run the following commands to start the new project locally: + + ```shell + cd + npx directus start + ``` + +Learn more about self-hosting Directus in our [Self-Hosted CLI Guide](/self-hosted/cli). :::danger Docker is Recommended While this method works and is maintained, it is not recommended. Docker removes environment-specific quirks that can lead to Directus not running properly in some contexts. +Running Directus without Docker may result in errors as a result of environment-specific characteristics. In such a +case, make sure you have the required system dependencies for `isolated-vm`, `sharp`, and `argon2` installed. + ::: ## 2. Create a Collection