Skip to content

Commit f039788

Browse files
authored
Update README.md
1 parent eeb59e8 commit f039788

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Opinionated project architecture for Full-Stack JavaScript Applications. _(work
66

77

88
## About
9-
Using JavaScript for full-stack has always been a challenge especially with architecting various pieces of the application, choosing technologies and managing devOps. This project provides a base for typical project consisting a Landing Website, Web and Mobile Applications, API service and easy deployment of various services. This project uses a microservice architecture where all individual project runs as a service (container).
9+
Using JavaScript for full-stack has always been a challenge especially with architecting various pieces of the application, choosing technologies and managing devOps. This project provides a base for typical project consisting a Landing Website, Web and Mobile Applications, API service and easy deployment of these services. This project uses a microservice architecture where all individual project runs as a service (container).
1010

11-
A typical SaaS product usually consists of following services:
11+
A typical product (SaaS, etc.) usually consists of following services:
1212
- Landing page
1313
- Used for introducing your business to customers
1414
- Provide links to download the mobile application
@@ -115,23 +115,26 @@ A typical SaaS product usually consists of following services:
115115

116116
## Setup and Running
117117
- Clone repo git clone [email protected]:atulmy/fullstack-javascript-architecture.git fullstack
118-
- Landing
118+
- **Landing**
119119
- Switch to `landing` directory `cd frontend/landing`
120-
- Dev
121-
- Configuration
122-
- Create local environment file `cp .env.dev.example .env`
123-
- Modify `.env` for
124-
- PORT `3000`
125-
- NODE_ENV `development` | `production`
126-
- LANDING_URL `http://localhost:3000`
127-
- WEB_URL `http://localhost:5000`
128-
- API_URL `http://localhost:8000`
129-
- CONTACT_PHONE, CONTACT_EMAIL, CONTACT_ADDRESS
130-
- GA_TRACKING_ID (Google analytics tracking ID)
131-
- Setup
132-
- Install dependencies: `npm install`
133-
- Run
134-
- Start Landing server: `npm start`, browse at http://localhost:3000*
120+
- Configuration
121+
- Create local environment file `cp .env.dev.example .env`
122+
- Modify `.env` for
123+
- PORT `3000`
124+
- NODE_ENV `development` | `production`
125+
- LANDING_URL `http://localhost:3000`
126+
- WEB_URL `http://localhost:5000`
127+
- API_URL `http://localhost:8000`
128+
- CONTACT_PHONE, CONTACT_EMAIL, CONTACT_ADDRESS
129+
- GA_TRACKING_ID (Google analytics tracking ID)
130+
- Setup
131+
- Install dependencies: `npm install`
132+
- Run
133+
- Start Landing server: `npm start`, browse at http://localhost:3000*
134+
- Code
135+
- Modular code base
136+
-
137+
135138

136139
## Screenshots
137140

0 commit comments

Comments
 (0)