Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s00d/larecipecodeviewer
https://github.com/s00d/larecipecodeviewer
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/s00d/larecipecodeviewer
- Owner: s00d
- Created: 2022-06-20T10:37:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-13T08:50:35.000Z (almost 2 years ago)
- Last Synced: 2024-11-21T18:48:35.706Z (about 1 month ago)
- Language: Vue
- Size: 458 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
LaRecipe CodeSimples
## Getting Started
1. Install the package via composer.
```bash
composer require s00d/larecipe-code-viewer
```
2. Use the provided VueJs component:
```html
```
3. Customize your component via props:
| Prop Name | Description | Data Type | Required | Default Value |
|-------------|---------------------------------------------------------------------------------|------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| baseUrl | Defines the base URL for the requests. | String | Optional | '' |
| url | Defines the endpoint URL for the request. | String | Required | N/A |
| method | Defines the HTTP method for the request. | String | Optional | 'GET' |
| cookies | Defines the cookies to be sent with the request. | Array | Optional | [] |
| header | Defines the headers to be sent with the request. | Array | Optional | [] |
| queryString | Defines the query string parameters to be sent with the request. | Array | Optional | [] |
| path | Defines the path parameters to be sent with the request. | Array | Optional | [] |
| postData | Defines the data to be sent with the request. | Array | Optional | [] |
| configs | Defines the configuration options for generating code snippets for the request. | Array | Optional | [ { snippet: 'shell', libraries: { cURL: 'curl', HTTPie: 'httpie', Wget: 'wget' } }, ... ] (an array of objects containing snippet and libraries keys) |
## License
This library is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.