Skip to content

Commit e6256db

Browse files
committed
Revamp README with updated setup, installation, and module overview
1 parent ce9ca97 commit e6256db

1 file changed

Lines changed: 18 additions & 67 deletions

File tree

README.md

Lines changed: 18 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,32 @@
1-
# 991FuchsiaSnake
1+
# Order Bulk Manager
22

3-
Welcome to my Adobe I/O Application!
3+
Speed up order processing with our app that adds new mass actions for invoicing and shipment. Push multiple orders to
4+
the queue at once and let automated background processing handle the rest — saving time, reducing errors, and keeping
5+
your operations smooth.
46

5-
## Setup
7+
# Installation
68

7-
- Populate the `.env` file in the project root and fill it as shown [below](#env)
9+
Module compatible with both Adobe Commerce SaaS and PaaS.
810

9-
## Local Dev
11+
## Prerequisites
1012

11-
- `aio app run` to start your local Dev server
12-
- App will run on `localhost:9080` by default
13+
- Node.js 20+
14+
- Adobe I/O CLI
1315

14-
By default the UI will be served locally but actions will be deployed and served from Adobe I/O Runtime. To start a
15-
local serverless stack and also run your actions locally use the `aio app run --local` option.
16+
## Adobe Console preparation
1617

17-
## Test & Coverage
18+
Go to [Adobe Developer Console](https://developer.adobe.com) and create a new project from the "App Builder" template.
19+
Adding a service "Adobe Commerce as a Cloud Service" is necessary for generating OAuth Server-to-Server credentials.
1820

19-
- Run `aio app test` to run unit tests for ui and actions
20-
- Run `aio app test --e2e` to run e2e tests
21+
## Installation
2122

22-
## Deploy & Cleanup
23+
- Clone the repository
24+
- Run `npm install` for installing dependencies
2325

24-
- `aio app deploy` to build and deploy all actions on Runtime and static files to CDN
25-
- `aio app undeploy` to undeploy the app
26+
## Environment variables
2627

27-
## Config
28+
- Rename default `env.dist` to `.env` for storing environment variables
2829

29-
### `.env`
30+
### Adobe Commerce SaaS
3031

31-
You can generate this file using the command `aio app use`.
3232

33-
```bash
34-
# This file must **not** be committed to source control
35-
36-
## please provide your Adobe I/O Runtime credentials
37-
# AIO_RUNTIME_AUTH=
38-
# AIO_RUNTIME_NAMESPACE=
39-
```
40-
41-
### `app.config.yaml`
42-
43-
- Main configuration file that defines an application's implementation.
44-
- More information on this file, application configuration, and extension configuration
45-
can be found [here](https://developer.adobe.com/app-builder/docs/guides/appbuilder-configuration/#appconfigyaml)
46-
47-
#### Action Dependencies
48-
49-
- You have two options to resolve your actions' dependencies:
50-
51-
1. **Packaged action file**: Add your action's dependencies to the root
52-
`package.json` and install them using `npm install`. Then set the `function`
53-
field in `app.config.yaml` to point to the **entry file** of your action
54-
folder. We will use `webpack` to package your code and dependencies into a
55-
single minified js file. The action will then be deployed as a single file.
56-
Use this method if you want to reduce the size of your actions.
57-
58-
2. **Zipped action folder**: In the folder containing the action code add a
59-
`package.json` with the action's dependencies. Then set the `function`
60-
field in `app.config.yaml` to point to the **folder** of that action. We will
61-
install the required dependencies within that directory and zip the folder
62-
before deploying it as a zipped action. Use this method if you want to keep
63-
your action's dependencies separated.
64-
65-
## Debugging in VS Code
66-
67-
While running your local server (`aio app run`), both UI and actions can be debugged, to do so open the vscode debugger
68-
and select the debugging configuration called `WebAndActions`.
69-
Alternatively, there are also debug configs for only UI and each separate action.
70-
71-
## Typescript support for UI
72-
73-
To use typescript use `.tsx` extension for react components and add a `tsconfig.json`
74-
and make sure you have the below config added
75-
```
76-
{
77-
"compilerOptions": {
78-
"jsx": "react"
79-
}
80-
}
81-
```

0 commit comments

Comments
 (0)