2024-09-22 20:48:05 +02:00
|
|
|
## About
|
|
|
|
|
|
2024-09-22 20:50:11 +02:00
|
|
|
The `webskel` utility provides skeletons (or "templates") to help you quickly
|
|
|
|
|
start your next web application or service. The concept is inspired by skeleton
|
2024-09-22 21:46:33 +02:00
|
|
|
directories in the UNIX world, where they serve as the basis for a new user's
|
|
|
|
|
`${HOME}` directory.
|
2024-09-22 20:48:05 +02:00
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
2024-09-22 20:50:11 +02:00
|
|
|
### CLI
|
2024-09-22 20:48:05 +02:00
|
|
|
|
2024-09-22 20:50:11 +02:00
|
|
|
#### webskel new
|
2024-09-22 20:48:05 +02:00
|
|
|
|
2024-09-22 20:50:11 +02:00
|
|
|
The `webskel new` command creates a new application from a specified skeleton.
|
|
|
|
|
For example, the following command will create a "myapp" directory using the
|
|
|
|
|
`@webskel/ruby-graphql-webpack-react` skeleton:
|
2024-09-22 20:48:05 +02:00
|
|
|
|
2024-09-22 20:50:11 +02:00
|
|
|
user@localhost$ webskel new @webskel/ruby-graphql-webpack-react myapp
|
2024-09-22 20:48:05 +02:00
|
|
|
|
2024-09-22 20:50:11 +02:00
|
|
|
#### webskel ls
|
2024-09-22 20:48:05 +02:00
|
|
|
|
2024-09-22 20:50:11 +02:00
|
|
|
The `webskel ls` command lists all available skeletons. These skeletons are
|
|
|
|
|
located in the [share/webskel/](share/webskel) directory, which is typically
|
|
|
|
|
installed relative to `/usr/local`:
|
|
|
|
|
|
|
|
|
|
user@localhost webskel ls
|
|
|
|
|
|
|
|
|
|
## Sources
|
|
|
|
|
|
|
|
|
|
* [GitHub](https://github.com/webskel/cli#readme)
|
|
|
|
|
* [GitLab](https://gitlab.com/webskel/cli#readme)
|
2024-09-22 22:00:41 +02:00
|
|
|
* [brew.bsd.cafe/@webskel](https://brew.bsd.cafe/webskel)
|
2024-09-22 20:48:05 +02:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/) <br>
|
|
|
|
|
See [LICENSE](./LICENSE)
|
