mirror of
https://github.com/OpenBankProject/API-Explorer-II.git
synced 2026-02-06 10:47:04 +00:00
docfix/Enhance the redme file regarding the build process
This commit is contained in:
parent
c611633897
commit
41a5da19f5
2
.gitignore
vendored
2
.gitignore
vendored
@ -11,7 +11,7 @@ node_modules
|
||||
.DS_Store
|
||||
dist
|
||||
dist-ssr
|
||||
server-dist
|
||||
dist-server
|
||||
coverage
|
||||
*.local
|
||||
.env
|
||||
|
||||
24
README.md
24
README.md
@ -56,17 +56,33 @@ npm test:unit
|
||||
|
||||
## Compile and Minify for Production
|
||||
|
||||
##### Build
|
||||
##### Build API-Explorer II front-end
|
||||
|
||||
```sh
|
||||
npm run build
|
||||
npm run-script build
|
||||
```
|
||||
|
||||
##### Start the backend server
|
||||
##### Build API-Explorer II back-end
|
||||
|
||||
```sh
|
||||
npx ts-node <path-to-your-install>/server/app.ts
|
||||
npm run-script build-server
|
||||
```
|
||||
|
||||
##### Start API-Explorer II back-end
|
||||
```sh
|
||||
npx ts-node <path-to-your-install>/server/app.js
|
||||
```
|
||||
|
||||
##### Check the status of API-Explorer II back-end
|
||||
```
|
||||
Please find a message at a log file similar to this one:
|
||||
|
||||
Backend is running. You can check a status at http://localhost:8085/api/status
|
||||
|
||||
and use the link to check the status
|
||||
```
|
||||
|
||||
|
||||
##### Nginx deployment
|
||||
|
||||
```config
|
||||
|
||||
@ -10,8 +10,6 @@ import path from 'path'
|
||||
|
||||
const port = 8085
|
||||
const app: Application = express()
|
||||
const host = process.env.VITE_OBP_API_EXPLORER_HOST
|
||||
const httpsOrNot = host ? (host.indexOf('https://') == 0 ? true : false) : true
|
||||
|
||||
// Initialize client.
|
||||
console.log(`--- Redis setup -------------------------------------------------`)
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"module": "commonjs",
|
||||
"esModuleInterop": true,
|
||||
"target": "ES6",
|
||||
"outDir": "server-dist",
|
||||
"outDir": "dist-server",
|
||||
"rootDir": "server",
|
||||
"resolveJsonModule": true,
|
||||
"emitDecoratorMetadata": true,
|
||||
|
||||
Loading…
Reference in New Issue
Block a user