Skip to content

Commit 0626306

Browse files
Merge pull request #534 from santoshshinde2012/feature/env
Feature/env
2 parents 8c900bb + 78dedb9 commit 0626306

28 files changed

+1961
-1961
lines changed

.env.local

Lines changed: 0 additions & 4 deletions
This file was deleted.

.env.stage

Lines changed: 0 additions & 4 deletions
This file was deleted.

.env.test

Lines changed: 0 additions & 4 deletions
This file was deleted.

README.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ Try it!! I am happy to hear your feedback or any kind of new features.
4545

4646
- Clone the Application `git clone https://github.com/santoshshinde2012/node-boilerplate.git`
4747
- Install the dependencies `npm install`
48-
- Start the application `npm run start:local`
48+
- Start the application `npm run dev`
4949

5050
## Start The application in Production Mode
5151

5252
- Install the dependencies `npm install`
5353
- Create the build `npm run build`
54-
- Start the application `npm run start:production`
55-
- Before starting make sure to creat prod environment `.env.prod` file
54+
- Start the application `npm run start`
55+
- Before starting make sure to update your `.env` values for your refrence just check `.env.example`
5656

5757

5858
## Project Structure
@@ -63,7 +63,6 @@ Try it!! I am happy to hear your feedback or any kind of new features.
6363
| **src/** | Source files |
6464
| **src/abstractions** | Abstarct classes and Interfaces |
6565
| **src/components** | REST API Components & Controllers |
66-
| **src/environments** | Application Environments Handling utility |
6766
| **src/lib** | Reusable utilises and library source code like a logger|
6867
| **src/middleware/** | Express Middlewares like error handler feature |
6968
| **build/** | Compiled source files will be placed here |
@@ -81,26 +80,18 @@ Try it!! I am happy to hear your feedback or any kind of new features.
8180

8281
Set the `APPLY_ENCRYPTION` environment variable to `true` to enable encryption.
8382

84-
## Global Environment Object
85-
86-
You can directly access the environment attributes in any component/file using global environment object. For more details please check file `src/global.ts`.
87-
88-
*Example*
89-
90-
To access the `applyEncryption` attribute from `Envionment` class to Response Handler, write `environment.applyEncryption`;
91-
9283
## Swagger API Documentation
9384

9485
The swagger documentation is available at the following url `${host}/docs`:
9586

9687
[http://localhost:8080/docs](http://localhost:8080/docs)
9788
## Default System Health Status API
9889

99-
- `${host}/api/status/system` - Return the system information in response
100-
- `${host}/api/status/time` - Return the current time in response
101-
- `${host}/api/status/usage` - Return the process and system memory usage in response
102-
- `${host}/api/status/process` - Return the process details in response
103-
- `${host}/api/status/error` - Return the error generated object in response
90+
- `${host}/api/system/info` - Return the system information in response
91+
- `${host}/system/time` - Return the current time in response
92+
- `${host}/system/usage` - Return the process and system memory usage in response
93+
- `${host}/system/process` - Return the process details in response
94+
- `${host}/system/error` - Return the error generated object in response
10495

10596
![Swagger API Documentation](https://github.com/santoshshinde2012/node-boilerplate/blob/master/wiki/swagger-api-documentation.jpg?raw=true)
10697

0 commit comments

Comments
 (0)