-
-
Notifications
You must be signed in to change notification settings - Fork 61
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: adds an installation guide #479
Merged
asyncapi-bot
merged 13 commits into
asyncapi:master
from
afzal442:create-installation-guide
Sep 25, 2023
Merged
Changes from 11 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
ad7d11a
docs: adds intro and installatn guide part
afzal442 61331b1
updates minor typos
afzal442 1a49d8a
adds usage
afzal442 e4192b0
modifies the header
afzal442 020f4d6
adds extra info to installation guide
afzal442 c42a11f
adds glee feature points and its diagram way
afzal442 61f2f6d
minor gm correction
afzal442 b3be4b6
subjugates the commits
afzal442 7097af0
rmvs intro part
afzal442 4c0eef6
updtes guide for usage
afzal442 0a78b28
extends the script desc
afzal442 1017fe5
adds the manual installation
afzal442 48a8601
adds the folder structure
afzal442 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 |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
title: 'Installation guide' | ||
weight: 30 | ||
--- | ||
|
||
## Glee Installation | ||
|
||
Before installing Glee into your project, make sure you have pre-installed NPM, NodeJs and [AsyncAPI CLI](https://github.com/asyncapi/cli) tools on your system. | ||
|
||
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). | ||
|
||
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 | ||
``` | ||
|
||
While making twists to your application, you can follow along with our getting started guide on the relevant page. | ||
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 |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
title: 'Usage' | ||
weight: 20 | ||
--- | ||
|
||
Glee as a spec-driven framework, makes it easier to work with applications in generating documentation and running the development server. | ||
|
||
By following the below json config from `package.json`, let's understand the usage of glee defined under `scripts` object. | ||
afzal442 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```js | ||
{ | ||
"scripts": { | ||
"docs": "glee docs", | ||
"dev": "glee dev", | ||
"start": "glee start", | ||
} | ||
} | ||
``` | ||
These scripts refer to the different stages of developing an application. | ||
|
||
`glee docs`: This script generates documentation for your project using the "Glee" documentation tool. This documentation includes information about your project's APIs, modules, and usage instructions. | ||
|
||
`glee dev`: This script is used for starting a development server. It launches a local development server, build your project in development mode, or perform other development-related tasks. | ||
|
||
`glee start`: This script is responsible for starting your project or application. It is used to launch a production-ready server or application instance. | ||
|
||
To get more familiar with these scripts on how they are configured, next dive into our getting started guide. |
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 think adding the link will be useful.
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.
Yes! I will do that once page rendered or reviewed with a link on the website itself