afront 1.0.8 → 1.0.10
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/README.md +18 -13
- package/install.js +2 -2
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -8,29 +8,25 @@
|
|
|
8
8
|
|
|
9
9
|
Before you begin, ensure you have the following installed:
|
|
10
10
|
|
|
11
|
-
- **Node.js**: You
|
|
11
|
+
- **Node.js**: You must have Node.js installed on your system. Download it from the [Node.js official website](https://nodejs.org/).
|
|
12
12
|
|
|
13
13
|
### Installation
|
|
14
14
|
|
|
15
|
-
1. **
|
|
16
|
-
|
|
17
|
-
- Download the latest release from the [Releases page](https://github.com/Asggen/afront/releases).
|
|
18
|
-
- Extract the contents of the release to a directory of your choice.
|
|
19
|
-
|
|
20
|
-
2. **Install Dependencies**
|
|
15
|
+
1. **Install AFront**
|
|
21
16
|
|
|
22
17
|
- Open your terminal or command prompt.
|
|
23
|
-
-
|
|
18
|
+
- To create a new project in a custom folder, run the following command:
|
|
24
19
|
```bash
|
|
25
|
-
|
|
20
|
+
npx afront <your-folder-name>
|
|
26
21
|
```
|
|
27
|
-
-
|
|
22
|
+
- To create the project in the current directory, run:
|
|
28
23
|
```bash
|
|
29
|
-
|
|
24
|
+
npx afront .
|
|
30
25
|
```
|
|
31
|
-
|
|
26
|
+
|
|
27
|
+
- Navigate to the root folder of the newly created project:
|
|
32
28
|
```bash
|
|
33
|
-
|
|
29
|
+
cd path/to/your/project
|
|
34
30
|
```
|
|
35
31
|
|
|
36
32
|
### Running the Project
|
|
@@ -70,3 +66,12 @@ Thank you for using **AFront**! We look forward to seeing what you build with it
|
|
|
70
66
|
This `README.md` file provides clear instructions on prerequisites, installation, and running the project in different environments. You can customize the links and details as needed for your specific project.
|
|
71
67
|
```
|
|
72
68
|
|
|
69
|
+
|
|
70
|
+
### Changes Made:
|
|
71
|
+
1. **Prerequisites**: Clarified that Node.js must be installed.
|
|
72
|
+
2. **Installation**: Added instructions to run `npx afront <your-folder-name>` to create a custom folder or `npx afront .` to create the project in the current directory.
|
|
73
|
+
3. **Running the Project**: This section remained the same.
|
|
74
|
+
|
|
75
|
+
You can now use this updated `README.md` in your project.
|
|
76
|
+
|
|
77
|
+
|
package/install.js
CHANGED
|
@@ -8,10 +8,10 @@ const AdmZip = require('adm-zip');
|
|
|
8
8
|
const readline = require('readline');
|
|
9
9
|
|
|
10
10
|
// Configuration
|
|
11
|
-
const GITHUB_ZIP_URL = 'https://github.com/Asggen/afront/archive/refs/tags/v1.0.
|
|
11
|
+
const GITHUB_ZIP_URL = 'https://github.com/Asggen/afront/archive/refs/tags/v1.0.10.zip'; // Updated URL
|
|
12
12
|
|
|
13
13
|
// Define files to skip
|
|
14
|
-
const SKIP_FILES = ['FUNDING.yml', 'CODE_OF_CONDUCT.md', 'SECURITY.md', 'install.js'];
|
|
14
|
+
const SKIP_FILES = ['FUNDING.yml', 'CODE_OF_CONDUCT.md', 'SECURITY.md', 'install.js', '.npmrc'];
|
|
15
15
|
|
|
16
16
|
// Initialize readline interface
|
|
17
17
|
const rl = readline.createInterface({
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "afront",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.10",
|
|
4
4
|
"description": "AFront is a front-end JavaScript library designed to create seamless server-side rendered (SSSR) websites.",
|
|
5
5
|
"main": "webpack.dev.js",
|
|
6
6
|
"scripts": {
|
|
@@ -11,6 +11,10 @@
|
|
|
11
11
|
"start": "webpack serve --config webpack.dev.js",
|
|
12
12
|
"static": "node server.js"
|
|
13
13
|
},
|
|
14
|
+
"repository": {
|
|
15
|
+
"type": "git",
|
|
16
|
+
"url": "git+https://github.com/Asggen/afront.git"
|
|
17
|
+
},
|
|
14
18
|
"keywords": [
|
|
15
19
|
"afront",
|
|
16
20
|
"ssr",
|