edgeone 1.0.33 → 1.1.0

package/README.md

@@ -56,7 +56,7 @@ After successful login, execute the initialization command to initialize the bas
 edgeone pages init
 ```
 
-After initialization, a `functions` folder and sample functions will be generated in the root directory of the project. You can continue to add and develop functions in this folder.
+After initialization, an `edge-functions` or `node-functions` folder and sample functions will be generated in the root directory of the project. You can continue to add and develop functions in this folder.
 
 ### 4. Local Development
 
@@ -66,35 +66,22 @@ After completing initialization, enter the local development stage:
 edgeone pages dev
 ```
 
-Executing the command will start a service on the local port 8088 by default. You can access the sample function via `http://localhost:8088/helloworld`. Here, the access path is the address path of the function file in the `functions` folder.
+Executing the command will start a service on the local port 8088 by default. The Pages Functions service and the Pages project run on the same port.
 
-During local development, the service for Pages Functions and the service for the Pages project may run on different ports. In order to allow the Pages project to call functions, you can use a proxy server or reverse proxy to forward requests to the correct port. Here is an example configuration of webpack-dev-server:
-
-```javascript
-module.exports = {
-  devServer: {
-    proxy: {
-      '/api': {
-        target: 'http://localhost:8088', // Local Development Service Address for Pages Function
-        chagneOrigin: true,
-        pathRewrite: {
-          '^/api': '',
-        },
-      },
-    },
-  },
-};
-```
-
-In this way, use the Fetch API in the Pages project:
+Visit the frontend at `http://localhost:8088/`, and call your functions directly using their file paths under `edge-functions` or `node-functions`.
 
 ```javascript
+// ./node-functions/api/my-functions.js
 fetch('/api/my-functions', {
   method: 'POST',
   body: JSON.stringify({ data: 'example' }),
 });
 ```
 
+Note:
+- The dev service will read `devCommand` from `edgeone.json` to start your dev server. If absent, it will read the `dev` script from your project's `package.json`.
+- Edge Functions debug service has a start count limit. Avoid frequently stopping and restarting the dev service. Hot reloads do not increase the count.
+
 ### 5. Associated Project
 
 If you need to use the Key-Value Storage capability or synchronize the environment variables set in the console to local debugging, you can execute the Associated Project commands, enter the project name as required. The project name here is the one created in the Preparation Work of the Pages project.
@@ -111,12 +98,23 @@ After local development and debugging are completed, you can deploy your project
 edgeone pages deploy <directoryOrZip> -n <projectName>
 ```
 
+Starting from version v1.1.0, direct deployment within the project is supported:
+
+```plaintext
+edgeone pages deploy -n <projectName>
+```
+The CLI will automatically build and initiate deployment based on the project configuration.
+
 #### Parameters
 
 - `<directoryOrZip>`: Path of folder or ZIP package to deploy (required)
 - `-n, --name`: Project name for deployment (creates new or updates existing project) (required)
 - `-e, --env`: Environment to deploy to, choices: 'production' or 'preview' (default: 'production')
 
+Note:
+- If you specify a deploy folder (e.g., `dist`), you need to manually copy the `node-functions` and/or `edge-functions` folders, as well as your project's `package.json`, into that folder before running `deploy`.
+- If you do not specify a deploy folder, the CLI will automatically bundle your frontend code and function code into the `.edgeone` directory, from which you can deploy using the `deploy` command.
+
 #### Usage Examples
 
 ```plaintext
@@ -139,26 +137,6 @@ If you need to switch to another Tencent Cloud account, you can execute the foll
 edgeone switch
 ```
 
-### 8. Combine with front end
-
-EdgeOne Pages CLI supports local development and debugging of EdgeOne Pages functions. If your project contains frontend code, you need to manually start the corresponding development service.
-
-For frontend applications that need to access local functions, currently you need to distinguish function access paths through environment variables in your frontend code:
-
-```
-// when start dev server
-ENV=dev npm run build
-
-//In your code
-const REQUEST_API = process.env.ENV === 'dev' ? 'https://localhost:8088/' : '/'
-```
-
-For functions involving cross-origin validation scenarios like login and authentication, you can specify the `--fePort` parameter when starting the development server.
-
-```
-edgeone pages dev --fePort=8000 // your front dev server port
-```
-
 <br/>
 
 ## 3. CI/CD Integration
@@ -170,7 +148,7 @@ This section provides guidance on integrating EdgeOne CLI into your CI/CD pipeli
 For CI/CD pipelines, you can use the same deploy command with an API Token for authentication:
 
 ```plaintext
-edgeone pages deploy <directoryOrZip> -n <projectName> -t <token>
+edgeone pages deploy <directoryOrZip> -n <projectName> -t <token> [-e <env>]
 ```
 
 #### Parameters
@@ -180,6 +158,10 @@ edgeone pages deploy <directoryOrZip> -n <projectName> -t <token>
 - `-e, --env`: Environment to deploy to, choices: 'production' or 'preview' (default: 'production')
 - `-t, --token`: API Token for CI/CD pipelines (required for automated deployments)
 
+Note:
+- If you specify a deploy folder (e.g., `dist`), you need to manually copy the `node-functions` and/or `edge-functions` folders, as well as your project's `package.json`, into that folder before running `deploy`.
+- If you do not specify a deploy folder, the CLI will automatically bundle your frontend code and function code into the `.edgeone` directory, from which you can deploy using the `deploy` command.
+
 #### CI/CD Pipeline Examples
 
 ```plaintext
@@ -214,4 +196,4 @@ _To access the China site documentation, please click [here](https://edgeone.clo
 
 ## Contact
 
-If you need technical support, please [contact us](https://edgeone.ai/contact?source=edgeone-cli).
+If you need technical support, please [contact us](https://edgeone.ai/contact?source=edgeone-cli).