You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+51-17Lines changed: 51 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,13 @@
1
1
# Migration v2
2
+
2
3
## Overview
4
+
3
5
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.
@@ -16,6 +20,7 @@ Check for readme.md files and install dependencies for folders
16
20
This is the migration V2's node server.
17
21
18
22
### Environment Variables
23
+
19
24
The following environment variables are used in this project:
20
25
21
26
-`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.
27
32
2. To run the production server, create a `./production.env` file and add environment variables as per `./example.env`
28
33
29
34
### To start the server
30
-
Run `npm run dev`
31
35
36
+
Run `npm run dev`
32
37
33
38
## Migration UI
34
39
35
40
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.
36
41
37
42
### Features
43
+
38
44
- User-friendly interface for content migration
39
45
- Integration with Contentstack
40
46
- State management with Redux Toolkit
@@ -43,14 +49,15 @@ Migration UI is a web application designed to facilitate the migration of conten
43
49
### Installation
44
50
45
51
1. Navigate to the project directory:
46
-
```sh
47
-
cd ui
48
-
```
52
+
53
+
```sh
54
+
cd ui
55
+
```
49
56
50
57
2. Install the dependencies:
51
-
```sh
52
-
npm install
53
-
```
58
+
```sh
59
+
npm install
60
+
```
54
61
55
62
### Environment Variables
56
63
@@ -66,14 +73,17 @@ The following environment variables are used in this project:
66
73
Make sure to set these variables in a `.env` file at the root of your ui project.
67
74
68
75
### Usage
76
+
69
77
Start the development server:
78
+
70
79
```sh
71
80
npm start
72
81
```
73
82
74
83
Open your browser and navigate to http://localhost:3000.
75
84
76
85
### Dependencies
86
+
77
87
-@contentstack/json-rte-serializer: ^2.0.5
78
88
-@contentstack/venus-components: ^2.2.4
79
89
-@reduxjs/toolkit: ^2.2.5
@@ -85,15 +95,21 @@ Open your browser and navigate to http://localhost:3000.
85
95
-@types/react-redux: ^7.1.33
86
96
87
97
## Migration v2 upload-api
98
+
88
99
### Overview
100
+
89
101
The migration-v2 upload-api project is designed to facilitate the migration of different CMS to Contentstack functionalities.
90
102
91
103
### Installation
104
+
92
105
Navigate to the project directory:
106
+
93
107
```
94
108
cd migration-v2/upload-api
95
109
```
110
+
96
111
Install dependencies:
112
+
97
113
```
98
114
npm install
99
115
```
@@ -108,6 +124,7 @@ The following environment variables are used in this project:
108
124
Make sure to set these variables in a `.env` file at the root of your project.
109
125
110
126
### Configuration
127
+
111
128
Please refer sample.config.json and provide this config in index.ts of config folder of upload-api/src
112
129
The following configuration is used in this project:
113
130
@@ -116,6 +133,7 @@ The following configuration is used in this project:
116
133
-`isLocalPath`: A flag to indicate if the path is local. Default is `true`.
117
134
118
135
#### AWS Data
136
+
119
137
-`awsRegion`: The AWS region. Default is `us-east-2`.
120
138
-`awsAccessKeyId`: The AWS access key ID.
121
139
-`awsSecretAccessKey`: The AWS secret access key.
@@ -124,22 +142,29 @@ The following configuration is used in this project:
124
142
-`buketKey`: The key for the AWS S3 bucket. Default is `project/package 45.zip`.
125
143
126
144
#### Local Path
145
+
127
146
-`localPath`: The local path to the extracted files. for example `/upload-api/extracted_files/package 45.zip`.
128
147
129
148
## Cli
149
+
130
150
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
+
```
141
165
142
166
## Scripts
167
+
143
168
-`npm start`: Starts the main server by running index.js.
144
169
-`npm run api`: Navigates to the api directory and runs the development server.
145
170
-`npm run upload`: Navigates to the upload-api directory and starts the upload API server.
@@ -149,29 +174,35 @@ Navigate to the project directory
149
174
-`npm test`: Displays an error message indicating that no tests are specified.
0 commit comments