Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adebola-io/pageweaver
Generate web project boilerplates quickly.
https://github.com/adebola-io/pageweaver
boilerplate boilerplate-template create-react-app node nodejs npm npm-module npm-package npx react template typescript vue
Last synced: 3 days ago
JSON representation
Generate web project boilerplates quickly.
- Host: GitHub
- URL: https://github.com/adebola-io/pageweaver
- Owner: adebola-io
- Created: 2022-01-16T15:14:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-02-06T05:39:25.000Z (over 2 years ago)
- Last Synced: 2024-09-21T12:13:40.188Z (12 days ago)
- Topics: boilerplate, boilerplate-template, create-react-app, node, nodejs, npm, npm-module, npm-package, npx, react, template, typescript, vue
- Language: JavaScript
- Homepage: https://pageweaver.netlify.app
- Size: 44.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Current Version: 0.0.3
Pageweaver is a Node JS command-line application for generating and managing web sites and apps.
## Contents
- [Contents](#contents)
- [Installation](#installation)
- [Usage](#usage)
- [Creation](#creation)
- [Creation Arguments](#creation-arguments)
- [Development](#development)
- [Production](#production)
- [Deletion](#deletion)
- [Complete Deletion](#complete-deletion)
---
## Installation
To get started,
1. Download the latest version of Node for your system.
2. Open up the terminal or command line interface:
3. Type in the following command and press Enter:
```console
npm install -g pageweaver
```
This will install pageweaver globally on your system, so that it can be used from any project. To install it locally use:
```console
npm install pageweaver
```
For more on local installation, see [here](LOCAL_USE.md).
---
## Usage
### Creation
To create a new app, use:
```console
pageweaver create-app app-name
```
##### Creation Arguments
Pageweaver allows you to generate complex apps by chaining arguments e.g.
```console
pageweaver create-app myapp --react-cli/17.0.6 --react-router --react-redux --typescript --scss
```
The above command will generate a new React v17.0.6 app called 'myapp' in the root folder, with SCSS, TSX, Redux and the React Router all pre-installed.
Learn more about the different creation arguments [here](CREATION.md).
Arguments and general data about a new web page or web app are stored in the `projects.config.json` file, which is also located in the root directory of your projects folder.
Manually editing or deleting the config file can lead to command malfunctions. It is not advisable to do so.
### Development
To start a development server for your web app, use:
```console
pageweaver serve-app app-name
```
The above command will open a port on the localhost and serve your project in the browser.
### Production
Pageweaver also provides you the feature of readying a project for production/deployment (provided it is developed with a supported framework).
To build a developed web app, run:
```console
pageweaver build-app app-name
```
Pageweaver will simply run the corresponding build command for the framework.
### Deletion
To delete an existing project, run:
```console
pageweaver delete-app app-name
```
Pageweaver-generated projects CANNOT be restored once they are deleted.
### Complete Deletion
If you want to erase every web project in every sub-directory in a folder, run:
```console
pageweaver nuke-folder
```
The above command will delete all the pageweaver-generated projects in the specified folder. As with the delete-app command, it CANNOT be undone.