-
-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adds extra info to installation guide
Signed-off-by: Afzal Ansari <[email protected]>
- Loading branch information
Showing
1 changed file
with
27 additions
and
1 deletion.
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 |
---|---|---|
|
@@ -9,8 +9,34 @@ Before installing Glee into your project, make sure you have pre-installed [Asyn | |
|
||
The best way to get started with Glee is by using AsyncAPI CLI, which sets up everything automatically for you. | ||
To create a project, run: | ||
|
||
```sh | ||
asyncapi new glee | ||
``` | ||
|
||
> For more information on how to install the AsynAPI CLI, you can review the [CLI installation guide](https://www.asyncapi.com/docs/tools/cli/installation). | ||
> For more information on how to install the AsynAPI CLI, you can review the [CLI installation guide](https://www.asyncapi.com/docs/tools/cli/installation). | ||
On installation, you'll find next steps after your project created: | ||
|
||
``` | ||
Your project "project" has been created successfully! | ||
Next steps: | ||
cd project | ||
npm install | ||
npm run dev | ||
Also, you can already open the project in your favorite editor and start tweaking it | ||
``` | ||
|
||
On following the next steps, you'll be able to view your application running, | ||
essentiaaly when you run the development server `npm run dev`: | ||
|
||
``` | ||
> [email protected] dev | ||
> glee dev | ||
TS Compiling TypeScript sources... | ||
``` |