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.

Sign up for GitHub

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

Update deploy doc #213

Merged
merged 1 commit into from
May 21, 2024
+17 −11
Merged

Update deploy doc #213

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 17 additions & 11 deletions app/docs/md/deployment/begin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ title: Begin

Install the Begin CLI by opening your terminal and entering the following command:

- Mac, Linux: `curl -sS https://dl.begin.com/install.sh | sh`
- Then follow the printed instructions to add Begin to your `$PATH`.
- Windows: `iwr https://dl.begin.com/install.ps1 -useb | iex`
```bash
npm i --global @begin/deploy
```

### Generate a new project

Expand Down Expand Up @@ -54,18 +54,24 @@ Create a real HTML form for CRUDL (create, read, update, destroy, and list) back
npx enhance generate scaffold Cat name:string birthday:date email:email
```

### Deploy
### Log in

<doc-callout level="caution" mark="🛠️">
Create a Begin account by running the following command in your terminal, then following the instructions to authorize with GitHub.

The new version of Begin is under active development and not yet generally available.
Account registration and `deploy` features will not work.
In the meantime, you can still use the `begin` CLI, `dev` Sandbox, and generators.
```bash
npx begin login
```

Sign up for early access at [Begin.com](https://begin.com).
### Deploy

</doc-callout>
Time to ship your brand new project to a fresh environment!

```bash
begin deploy
npx begin deploy
```

<doc-callout level="info" mark="📖">

Read more about how automating releases via [GitHub Actions](https://begin.com/deploy/docs/getting-started/github-actions).

</doc-callout>
Loading