Skip to content

Commit 3ab258d

Browse files
committed
Update
- Project date set dynamic - Description - Readme - Security
1 parent 1d5db0d commit 3ab258d

File tree

4 files changed

+61
-42
lines changed

4 files changed

+61
-42
lines changed

README.md

Lines changed: 57 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,23 @@
1313
![Gzipped](https://img.shields.io/bundlephobia/minzip/generator-webpack-preact.svg?style=flat "Minified & Gzipped")
1414

1515
<div style="text-align:center; display: block;">
16-
<img style="width:150px;" src="https://media4.giphy.com/media/4KzpjLvJjJknJ5Xuak/giphy.gif?cid=ecf05e47t4rc89yc0kv329d4d10ga4ti7qo08pyth1w9c9c6&rid=giphy.gif" width="150"/>
16+
<img src="https://media4.giphy.com/media/4KzpjLvJjJknJ5Xuak/giphy.gif?cid=ecf05e47t4rc89yc0kv329d4d10ga4ti7qo08pyth1w9c9c6&rid=giphy.gif" width="300"/>
1717
</div>
1818

1919
# OVERVIEW
2020

21-
This scaffold creates in seconds for you a professional environment to develop with a package of [Webpack](https://webpack.js.org/), [TypeScript](https://github.com/Microsoft/TypeScript), [Preact](https://github.com/developit/preact), [Redux-Zero](https://github.com/redux-zero/redux-zero) and [Babel](https://github.com/babel/babel). Code a application in HTML (5), SASS (CSS), TS (X) and JS (X).
21+
This scaffold creates in seconds for you a professional environment. Code a application in HTML(5), (S)CSS, TS(X) and JS(X). All what you need for Apps.
2222

23-
- Webpack (Bundler)
24-
- TypeScript (Code in ES6 or higher)
25-
- Preact (TSX and JSX)
26-
- Redux-Zero (Storage)
27-
- Babel (Compile back for Browserslist to last 2 versions or other options)
23+
- [Webpack](https://webpack.js.org/) (Bundler)
24+
- [TypeScript](https://github.com/Microsoft/TypeScript) (Code in ES6 or higher)
25+
- [Preact](https://github.com/developit/preact) (TSX and JSX)
26+
- [Redux-Zero](https://github.com/redux-zero/redux-zero) (Storage)
27+
- [Babel](https://github.com/babel/babel) (Compile back for Browserslist to last 2 versions or other options)
2828

2929
A total solution for your projects. You have with this scaffold the followed.
3030

31-
- Install with [yeoman](https://yeoman.io/) and [webpack](https://github.com/webpack/webpack-cli).
3231
- 5 Prompts for create the project.
33-
- NPM Install dependencies after scaffolding ready.
32+
- Automatically install dependencies after scaffolding ready.
3433
- Development Server with Hot Module Replacement (HMR) ready.
3534
- Welcome window with introduction for next steps after install.
3635
- Configs was splited to development and production.
@@ -51,23 +50,30 @@ More information over the [Project Structur](https://github.com/prod3v3loper/gen
5150

5251
# INSTALL
5352

54-
1. Install [Node.js](https://nodejs.org/en/) to use the NPM (Node Package Manager), if not installed.
55-
- Additional you can install NVM (Node Version Manager) https://github.com/nvm-sh/nvm to change version
56-
2. You can use `yo` (Yeoman) to install the scaffold and start with it.
57-
- lso install yeoman global `npm install -g yo`.
53+
1. Install [Node.js](https://nodejs.org/en/) to use the [NPM](https://www.npmjs.com/) (Node Package Manager), if not installed.
54+
- Check your NPM version `npm -v`
55+
- Additional you can install [NVM](https://github.com/nvm-sh/nvm#installing-and-updating) (Node Version Manager) to change version.
56+
2. We use `yo` ([Yeoman Generator](https://yeoman.io/)) to install the scaffold and start with it.
57+
- Also install yeoman global `npm install -g yo`
5858

59-
> LOCAL
59+
## LOCAL
6060

61-
Switch to your projects folder.
61+
> To use only in your project.
62+
63+
Switch to your projects folder, to install it in the project.
6264

6365
```bash
6466
username$ cd /Users/username/projects/
6567
```
6668

69+
And install.
70+
6771
```bash
6872
projects$ npm i generator-webpack-preact
6973
```
7074

75+
Now call yeoman.
76+
7177
```bash
7278
projects$ yo
7379
```
@@ -80,23 +86,23 @@ If promt a call
8086
> webpack-preact
8187
```
8288
83-
or directly
89+
or say yeoman directly the generator you want to use.
8490
8591
```bash
8692
projects$ yo webpack-preact
8793
```
8894
89-
Enter and create your project
95+
Enter and create your project. You are ready to developing.
9096
91-
> GLOBAL
97+
## GLOBAL
9298
93-
To use it from everywhere install the generator global
99+
> To use it from everywhere install the generator global.
94100
95101
```bash
96-
projects$ sudo npm i -g generator-webpack-preact
102+
projects$ npm i -g generator-webpack-preact
97103
```
98104
99-
Type password and now run in everywhere in your project folders, no local install need anymore
105+
No local install need anymore, you cann now call everytime everywhere `yo webpack-preact`.
100106
101107
```bash
102108
projects$ yo
@@ -116,11 +122,11 @@ or directly
116122
projects$ yo webpack-preact
117123
```
118124

119-
Enter and create your project
125+
Enter and create your project. You are ready to developing.
120126

121127
# Promt for the solution
122128

123-
And we become a promt ;)
129+
And we become a promt, after choose our generator `webpack preact` ;)
124130

125131
```bash
126132
? Customer name? (customer)
@@ -130,7 +136,7 @@ And we become a promt ;)
130136
? Want you install all dependencies? Y/n
131137
```
132138

133-
After answer all questions start the create
139+
After answerring all questions, start the create process.
134140

135141
```bash
136142
create src/index.tsx
@@ -214,7 +220,7 @@ Projects
214220
215221
```
216222

217-
# Usage
223+
# USAGE
218224

219225
Now run and see the Magic :)
220226

@@ -245,9 +251,11 @@ newsletter$ npm run prod
245251
To close (stop the localhost server) the NPM run type in console (Terminal):
246252
Ctrl + C
247253

248-
## Create a new Component
254+
# COMPONENTS
249255

250-
### Images and Videos
256+
Create your own components, or request a feature issue. Here two samples.
257+
258+
## Images or Videos
251259

252260
Import your sass or css files in easy way.
253261
Import all your images and videos.
@@ -338,6 +346,23 @@ Global
338346
projects$ npm uninstall -g generator-webpack-preact
339347
```
340348

349+
# ISSUE
350+
351+
Please use the issue tab to request a:
352+
353+
* Bug
354+
* Feature
355+
356+
Choose template and report [issues](https://github.com/prod3v3loper/generator-webpack-preact/issues).
357+
358+
# CONTRIBUTE
359+
360+
Please read the [contributing](https://github.com/prod3v3loper/generator-webpack-preact/blob/master/CONTRIBUTING.md) to contribute.
361+
362+
# VULNERABILITY
363+
364+
Please use the Security section for privately reporting a [vulnerability](https://github.com/prod3v3loper/generator-webpack-preact/security).
365+
341366
# PACKAGE
342367

343368
You find generator-webpack-preact in [Yeoman generator](https://yeoman.io/generators/), [NPM](https://www.npmjs.com/) and on [Github](https://github.com/).
@@ -348,18 +373,14 @@ You find generator-webpack-preact in [Yeoman generator](https://yeoman.io/genera
348373

349374
[Github Theme - generator-webpack-preact](https://prod3v3loper.github.io/generator-webpack-preact/)
350375

351-
# Contribute
352-
353-
Please read the [contributing](https://github.com/prod3v3loper/generator-webpack-preact/blob/master/CONTRIBUTING.md).
354-
355-
# Authors
376+
# AUTHOR
356377

357-
**[Samet Tarim](https://www.prod3v3loper.com)** - _All works_
378+
[prod3v3loper](https://www.prod3v3loper.com)
358379

359-
# Support
380+
# SUPPORT
360381

361382
[Hyperly](https://www.hyperly.de)
362383

363-
# License
384+
# LICENSE
364385

365-
[MIT](https://github.com/prod3v3loper/generator-webpack-preact/blob/master/LICENSE) - [prod3v3loper](https://www.tnado.com/author/prod3v3loper/)
386+
[MIT](https://github.com/prod3v3loper/generator-webpack-preact/blob/master/LICENSE)

SECURITY.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,4 @@ We only support the latest version.
1313

1414
## Reporting a Vulnerability
1515

16-
Please use the Security section for privately reporting a [security vulnerability](https://github.com/prod3v3loper/generator-webpack-preact/security).
17-
1816
For more information lokk at [GitHub docs](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).

app/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ const createDevConfig = require("./settings/configs/dev");
2020
* @author Samet Tarim aka prod3v3loper
2121
* @copyright Copyright (C) 2021 Samet Tarim - All rights reserved
2222
* @license MIT
23-
* @version 1.3.5
23+
* @version 1.3.6
2424
* @since 1.0
2525
* @package MELABUAI
2626
* @subpackage generator-webpack-preact
@@ -101,7 +101,7 @@ module.exports = class WebpackGenerator extends Generator {
101101
type: "input",
102102
name: "year",
103103
message: "Project year?",
104-
default: "2023",
104+
default: new Date().getFullYear(),
105105
},
106106
{
107107
type: "input",

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "generator-webpack-preact",
3-
"description": "Create professional projects and manage in environment with Webpack, TypeScript, Preact, Redux-Zero and Babel. HTML (5), SASS (CSS), TS (X) and JS (X). Small and compact solution. By prod3v3loper",
4-
"version": "1.3.5",
3+
"description": "Create professional projects and manage, in environment with: Webpack, TypeScript, Preact, Redux-Zero and Babel. HTML(5), (S)CSS, TS(X) and JS(X). All what you need for Apps. By prod3v3loper",
4+
"version": "1.3.6",
55
"main": "./app/index.js",
66
"scripts": {},
77
"files": [

0 commit comments

Comments
 (0)