sasjs/server
1
0
Fork 0
mirror of https://github.com/sasjs/server.git synced 2025-12-11 03:34:35 +00:00
Code Issues Projects Releases Wiki Activity

chore: readme updated

Browse Source
This commit is contained in:
Saad Jutt
2021-11-15 05:39:30 +05:00
parent 8a6e8f54f1
commit ca49aad153
2 changed files with 27 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -10,9 +10,16 @@ One major benefit of using SASjs Server (alongside other components of the SASjs
## Configuration ## Configuration
Configuration is made in the `configuration` section of `package.json`:
- Provide path to SAS9 executable.
### Using dockers: ### Using dockers:
There is `.env.example` file present at root of the project. There is `.env.example` file present at root of the project. [for Production]
There is `.env.example` file present at `./api` of the project. [for Development]
There is `.env.example` file present at `./web` of the project. [for Development]
Remember to provide enviornment variables.
#### Development #### Development
@@ -53,7 +60,8 @@ It will build following images if running first time:
##### API ##### API
There is `.env.example` file present at `./api` directory. Navigate to `./api`
There is `.env.example` file present at `./api` directory. Remember to provide enviornment variables else default values will be used mentioned in `.env.example` files
Command to install and run api server. Command to install and run api server.
``` ```
@@ -63,7 +71,8 @@ npm start
##### Web ##### Web
There is `.env.example` file present at `./web` directory. Navigate to `./web`
There is `.env.example` file present at `./web` directory. Remember to provide enviornment variables else default values will be used mentioned in `.env.example` files
Command to install and run api server. Command to install and run api server.
``` ```
@@ -73,9 +82,9 @@ npm start
#### Development (running only api server and have web build served): #### Development (running only api server and have web build served):
##### API ##### API server also serving Web build files
There is `.env.example` file present at `./api` directory. There is `.env.example` file present at `./api` directory. Remember to provide enviornment variables else default values will be used mentioned in `.env.example` files
Command to install and run api server. Command to install and run api server.
``` ```
@@ -83,6 +92,16 @@ cd ./web && npm i && npm build && cd ../
cd ./api && npm i && npm start cd ./api && npm i && npm start
``` ```
#### Production
##### API & WEB
```
npm run server
```
This will install/build `web` and install `api`, then start prod server.
## Executables ## Executables
Command to generate executables Command to generate executables

4
api/package.json
View File

@@ -26,7 +26,9 @@
"./web/build/**/*" "./web/build/**/*"
], ],
"targets": [ "targets": [
"node16-macos-x64" "node16-linux-x64",
"node16-macos-x64",
"node16-win-x64"
], ],
"outputPath": "../executables" "outputPath": "../executables"
}, },