-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7e14b32
commit 89bbc9d
Showing
1 changed file
with
34 additions
and
0 deletions.
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 |
---|---|---|
@@ -1,2 +1,36 @@ | ||
# samples | ||
A collection of simple examples that demonstrate the use of various argon.js features | ||
|
||
## Local Development | ||
|
||
Setup: [Install Jekyll](https://jekyllrb.com/docs/installation/) | ||
|
||
```sh | ||
git clone https://github.com/argonjs/samples.git # Clone the repository. | ||
cd samples && npm install # Install dependencies. | ||
npm run devsite # Generate a local development site in _site. | ||
npm run serve # Start the local development server. | ||
``` | ||
|
||
And open in your browser **[http://localhost:1337](http://localhost:1337)**. | ||
|
||
When you change the ts files, rebuild with `npm run build`. | ||
|
||
When you change the HTML or js files, you need to regenerate _site with `npm run devsite`. | ||
|
||
## Questions | ||
|
||
For questions and support, [ask on one of our support channels](https://www.argonjs.io/#develop). | ||
|
||
## Stay in Touch | ||
|
||
- To hang out with the community, join the argonjs slack ([see the slack-join link in our developer support links](https://www.argonjs.io/#develop)). | ||
- [Follow @argonjs on Twitter](https://twitter.com/argonjs). | ||
|
||
## Contributing | ||
|
||
Get involved! Check out the [Contributing Guide](CONTRIBUTING.md) for how to get started. | ||
|
||
## License | ||
|
||
This program is free software and is distributed under an [Apache License](LICENSE.txt). |