Skip to content

Commit 053e6aa

Browse files
authored
Merge pull request #445 from contentstack/stage
Stage
2 parents 7ec0eb1 + 421f3cf commit 053e6aa

File tree

1,045 files changed

+37162
-190828
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,045 files changed

+37162
-190828
lines changed

.github/workflows/repo-sync.yml

Lines changed: 400 additions & 0 deletions
Large diffs are not rendered by default.

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,10 +349,15 @@ MigrationBackup/
349349
# Ionide (cross platform F# VS Code tools) working folder
350350
.ionide/
351351

352+
**.DS_Store
352353

353354
upload-api/node_modules
354355
upload-api/build
355356
ui/.env
356357
upload-api/sitecoreMigrationData
357358
upload-api/cmsMigrationData
358359
upload-api/extracted_files
360+
*.zip
361+
*copy*
362+
**/package-lock.json
363+
.qodo

.talismanrc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@ fileignoreconfig:
22
- filename: .github/workflows/secrets-scan.yml
33
ignore_detectors:
44
- filecontent
5-
version: "1.0"
5+
- filename: remove-broken-imports.js
6+
checksum: d9d3ca95b2f4df855c8811c73b5714e80b31e5e84b46affa0cb514dcfcc145bf
7+
version: "1.0"

.vscode/extensions.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
"recommendations": [
77
"dbaeumer.vscode-eslint",
88
"snyk-security.snyk-vulnerability-scanner",
9-
"SonarSource.sonarlint-vscode"
9+
"SonarSource.sonarlint-vscode",
10+
"github.copilot"
1011
],
1112
// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
1213
"unwantedRecommendations": []

README.md

Lines changed: 51 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# Migration v2
2+
23
## Overview
4+
35
The migration-v2 project is designed to facilitate the migration of assets and related functionalities. This project includes multiple components such as API, UI, and upload API.
46

57
## Installation
8+
69
Clone the repository:
10+
711
```
812
git clone https://github.com/contentstack/migration-v2.git
913
cd migration-v2
@@ -16,6 +20,7 @@ Check for readme.md files and install dependencies for folders
1620
This is the migration V2's node server.
1721

1822
### Environment Variables
23+
1924
The following environment variables are used in this project:
2025

2126
- `APP_TOKEN_KEY`: The token key for the application. Default is `MIGRATION_V2`.
@@ -27,14 +32,15 @@ Make sure to set these variables in a `.env` file at the root of your project.
2732
2. To run the production server, create a `./production.env` file and add environment variables as per `./example.env`
2833

2934
### To start the server
30-
Run `npm run dev`
3135

36+
Run `npm run dev`
3237

3338
## Migration UI
3439

3540
Migration UI is a web application designed to facilitate the migration of content. It provides a user-friendly interface for managing and migrating content efficiently.
3641

3742
### Features
43+
3844
- User-friendly interface for content migration
3945
- Integration with Contentstack
4046
- State management with Redux Toolkit
@@ -43,14 +49,15 @@ Migration UI is a web application designed to facilitate the migration of conten
4349
### Installation
4450

4551
1. Navigate to the project directory:
46-
```sh
47-
cd ui
48-
```
52+
53+
```sh
54+
cd ui
55+
```
4956

5057
2. Install the dependencies:
51-
```sh
52-
npm install
53-
```
58+
```sh
59+
npm install
60+
```
5461

5562
### Environment Variables
5663

@@ -66,14 +73,17 @@ The following environment variables are used in this project:
6673
Make sure to set these variables in a `.env` file at the root of your ui project.
6774

6875
### Usage
76+
6977
Start the development server:
78+
7079
```sh
7180
npm start
7281
```
7382

7483
Open your browser and navigate to http://localhost:3000.
7584

7685
### Dependencies
86+
7787
- @contentstack/json-rte-serializer: ^2.0.5
7888
- @contentstack/venus-components: ^2.2.4
7989
- @reduxjs/toolkit: ^2.2.5
@@ -85,15 +95,21 @@ Open your browser and navigate to http://localhost:3000.
8595
- @types/react-redux: ^7.1.33
8696

8797
## Migration v2 upload-api
98+
8899
### Overview
100+
89101
The migration-v2 upload-api project is designed to facilitate the migration of different CMS to Contentstack functionalities.
90102

91103
### Installation
104+
92105
Navigate to the project directory:
106+
93107
```
94108
cd migration-v2/upload-api
95109
```
110+
96111
Install dependencies:
112+
97113
```
98114
npm install
99115
```
@@ -108,6 +124,7 @@ The following environment variables are used in this project:
108124
Make sure to set these variables in a `.env` file at the root of your project.
109125

110126
### Configuration
127+
111128
Please refer sample.config.json and provide this config in index.ts of config folder of upload-api/src
112129
The following configuration is used in this project:
113130

@@ -116,6 +133,7 @@ The following configuration is used in this project:
116133
- `isLocalPath`: A flag to indicate if the path is local. Default is `true`.
117134

118135
#### AWS Data
136+
119137
- `awsRegion`: The AWS region. Default is `us-east-2`.
120138
- `awsAccessKeyId`: The AWS access key ID.
121139
- `awsSecretAccessKey`: The AWS secret access key.
@@ -124,22 +142,29 @@ The following configuration is used in this project:
124142
- `buketKey`: The key for the AWS S3 bucket. Default is `project/package 45.zip`.
125143

126144
#### Local Path
145+
127146
- `localPath`: The local path to the extracted files. for example `/upload-api/extracted_files/package 45.zip`.
128147

129148
## Cli
149+
130150
Navigate to the project directory
131-
1. Install pnpm
132-
Since pnpm is required, you need to install it globally if it's not already installed:
133-
```
134-
npm install -g pnpm
135-
```
136-
2. Run the Setup Script
137-
Now, run the main setup script specified in the package.json:
138-
```
139-
npm run setup-repo
140-
```
151+
152+
1. Install pnpm
153+
Since pnpm is required, you need to install it globally if it's not already installed:
154+
155+
```
156+
npm install -g pnpm
157+
```
158+
159+
2. Run the Setup Script
160+
Now, run the main setup script specified in the package.json:
161+
162+
```
163+
npm run setup-repo
164+
```
141165

142166
## Scripts
167+
143168
- `npm start`: Starts the main server by running index.js.
144169
- `npm run api`: Navigates to the api directory and runs the development server.
145170
- `npm run upload`: Navigates to the upload-api directory and starts the upload API server.
@@ -149,29 +174,35 @@ Navigate to the project directory
149174
- `npm test`: Displays an error message indicating that no tests are specified.
150175

151176
## Repository
177+
152178
- Type: git
153179
- URL: https://github.com/contentstack/migration-v2.git
154180

155181
## Bugs and Issues
182+
156183
- URL: https://github.com/contentstack/migration-v2/issues
157184

158185
## Homepage
186+
159187
- URL: https://github.com/contentstack/migration-v2#readme
160188

161189
## DevDependencies
190+
162191
- husky: ^4.3.8
163192
- prettier: ^2.4.1
164193
- rimraf: ^3.0.2
165194
- validate-branch-name: ^1.3.0
166195

167196
## Husky Configuration
197+
168198
```
169199
"husky": {
170200
"hooks": {}
171201
}
172202
```
173203

174204
- Branch Name Validation
205+
175206
```
176207
"validate-branch-name": {
177208
"pattern": "^(feature|bugfix|hotfix)/[a-z0-9-]{5,30}$",
@@ -180,10 +211,13 @@ Navigate to the project directory
180211
```
181212

182213
## License
214+
183215
This project is licensed under the ISC License.
184216

185217
## Author
218+
186219
The author information is not specified.
187220

188221
## Contact
222+
189223
For further assistance, please contact the project maintainer through the issues page on GitHub.

api/.eslintrc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,6 @@
2828
],
2929
"func-names": [0],
3030
"no-console": ["error", { "allow": ["warn", "error", "info"] }],
31-
"@typescript-eslint/no-explicit-any": "off"
31+
"@typescript-eslint/no-explicit-any": "warn"
3232
}
3333
}

api/.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ dist/
1717
# Mono auto generated files
1818
mono_crash.*
1919

20+
2021
# Build results
2122
[Dd]ebug/
2223
[Dd]ebugPublic/
@@ -358,8 +359,11 @@ combine.log
358359

359360

360361
!example.env
362+
!production.env
361363

362364
database/
363365
/sitecoreMigrationData
364366
/cmsMigrationData
365-
/migration-data
367+
/migration-data
368+
**/copy*
369+
**copy.ts

0 commit comments

Comments
 (0)