-
Notifications
You must be signed in to change notification settings - Fork 2k
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
michaelparkadze
wants to merge
2
commits into
payloadcms:main
Choose a base branch
from
michaelparkadze:patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+33
−7
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
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 | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.