Skip to content

Commit 6ea1383

Browse files
authored
Update README.md
1 parent 156d977 commit 6ea1383

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

README.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ 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 microserice 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 various services. This project uses a microservice architecture where all individual project runs as a service (container).
1010

1111

1212
## Core Structure
@@ -88,11 +88,37 @@ Using JavaScript for full-stack has always been a challenge especially with arch
8888
- React Navigation
8989

9090
### Deployment
91-
- Containerize
92-
- Technologies
93-
- Docker
94-
- Docker compose
91+
- Technologies
92+
- Docker
93+
- Docker compose
94+
9595

96+
## Setup and Running
97+
- Legend
98+
- * represents default values
99+
- Clone repo git clone [email protected]:atulmy/fullstack-javascript-architecture.git fullstack
100+
- Landing
101+
- Switch to `landing` directory `cd frontend/landing`
102+
- Dev
103+
- Configuration
104+
- Create local environment file `cp .env.dev.example .env`
105+
- Modify `.env` for
106+
- PORT
107+
- 3000*
108+
- NODE_ENV
109+
- `development`* | `production`
110+
- LANDING_URL
111+
- http://localhost:3000*
112+
- WEB_URL
113+
- http://localhost:5000*
114+
- API_URL
115+
- http://localhost:8000*
116+
- CONTACT_PHONE, CONTACT_EMAIL, CONTACT_ADDRESS
117+
- GA_TRACKING_ID (Google analytics tracking ID)
118+
- Setup
119+
- Install dependencies: `npm install`
120+
- Run
121+
- Start Landing server: `npm start`, browse at http://localhost:3000*
96122

97123
## Screenshots
98124

0 commit comments

Comments
 (0)