croct 0.0.0 → 0.1.0-alpha
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +62 -0
- package/index.js +1832 -0
- package/package.json +95 -7
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020 Croct.com
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://croct.com" target="_blank">
|
|
3
|
+
<picture>
|
|
4
|
+
<source media="(min-width: 769px) and (prefers-color-scheme: light)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-light.svg">
|
|
5
|
+
<source media="(min-width: 769px) and (prefers-color-scheme: dark)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-dark.svg">
|
|
6
|
+
<source media="(max-width: 768px) and (prefers-color-scheme: dark)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-dark-mobile.svg">
|
|
7
|
+
<source media="(max-width: 768px) and (prefers-color-scheme: light)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-light-mobile.svg">
|
|
8
|
+
<img src="https://raw.githubusercontent.com/croct-tech/plug-js/refs/heads/update-readme/.github/assets/header-light-mobile.svg" alt="Croct CLI" title="Croct CLI" width="100%">
|
|
9
|
+
</picture>
|
|
10
|
+
</a>
|
|
11
|
+
<br/>
|
|
12
|
+
<strong>Croct CLI</strong><br/>
|
|
13
|
+
A command-line interface for managing projects using Croct.
|
|
14
|
+
</p>
|
|
15
|
+
<div align="center">
|
|
16
|
+
<strong>📘 <a href="https://docs.croct.com/reference/cli/installation">Quick start →</a></strong>
|
|
17
|
+
</div>
|
|
18
|
+
<br/>
|
|
19
|
+
<p align="center">
|
|
20
|
+
<a href="https://www.npmjs.com/package/croct"><img alt="Version" src="https://img.shields.io/npm/v/croct"/></a>
|
|
21
|
+
<a href="https://codeclimate.com/repos/67e16a086bc3e963370499cb/test_coverage"><img alt="Coverage" src="https://api.codeclimate.com/v1/badges/8b341de649404ce56976/test_coverage"/></a>
|
|
22
|
+
</p>
|
|
23
|
+
|
|
24
|
+
## Introduction
|
|
25
|
+
|
|
26
|
+
The Croct CLI provides a set of commands for managing projects using Croct and using [templates](https://croct.com/templates).
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
Run the following command to install the latest version of the Croct CLI:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm i -g croct
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
To initialize a new project, run the following command:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
croct init
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
For more information, visit our [official documentation](https://docs.croct.com/reference/cli/installation).
|
|
43
|
+
|
|
44
|
+
## Documentation
|
|
45
|
+
|
|
46
|
+
Visit our [official documentation](https://docs.croct.com/reference/sdk/cli/installation).
|
|
47
|
+
|
|
48
|
+
## Support
|
|
49
|
+
|
|
50
|
+
Join our official [Slack channel](https://croct.link/community) to get help from the Croct team and other developers.
|
|
51
|
+
|
|
52
|
+
## Contribution
|
|
53
|
+
|
|
54
|
+
Contributions are always welcome!
|
|
55
|
+
|
|
56
|
+
- Report any bugs or issues on the [issue tracker](https://github.com/croct-tech/plug-next/issues).
|
|
57
|
+
- For major changes, please [open an issue](https://github.com/croct-tech/plug-next/issues) first to discuss what you would like to change.
|
|
58
|
+
- Please make sure to update tests as appropriate. Run tests with `npm test`.
|
|
59
|
+
|
|
60
|
+
## License
|
|
61
|
+
|
|
62
|
+
This library is licensed under the [MIT license](LICENSE).
|