Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added missing step from multi tentant example quick start #10362

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 33 additions & 7 deletions examples/multi-tenant/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,41 @@ This example demonstrates how to achieve a multi-tenancy in [Payload](https://gi

To spin up this example locally, follow these steps:

1. Run the following command to create a project from the example:
### 1. Create the Project
Run the following command to set up the project:

- `npx create-payload-app --example multi-tenant`
```bash
npx create-payload-app --example multi-tenant
```

2. `pnpm dev`, `yarn dev` or `npm run dev` to start the server
- Press `y` when prompted to seed the database
3. `open http://localhost:3000` to access the home page
4. `open http://localhost:3000/admin` to access the admin panel
- Login with email `[email protected]` and password `demo`
### 2. Configure Environment Variables
Duplicate the .env.example file and rename it to .env

```bash
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's necessary to document the contents of .env.example, as the user will already have them once they copy .env.example to .env

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AlessioGr I agree, I looked at the other README files of the other examples, they include the cp command example for this part. Let me know if this way is better.

cp .env.example .env
```

### 3. Start the Development Server
Use your preferred package manager to start the server:

```bash
pnpm dev
```
```bash
yarn dev
```
```bash
npm dev
```

> When prompted, press y to seed the database.

### 4. Access the Application

- Home Page: Open http://localhost:3000 in your browser.
- Admin Panel: Open http://localhost:3000/admin and log in with the following credentials:
- Email: [email protected]
- Password: demo

## How it works

Expand Down