@@ -115,6 +115,33 @@ A typical product (SaaS, etc.) usually consists of following services:
115115
116116## Setup and Running
117117- Clone repo git clone
[email protected] : atulmy /fullstack-javascript-architecture.git fullstack
118+
119+ - ** API**
120+ - Info
121+ - Authentication strategy: [ JWT] ( https://jwt.io/introduction/ ) (JSON Web Token)
122+ - Uses [ RPC] ( https://www.jsonrpc.org/ ) (Remote Procedure Call) for API endpoints (one endpoint URL, multiple operations)
123+ - Resources
124+ - [ Lightweight RPC API pattern] ( https://github.com/atulmy/wispy )
125+ - Switch to ` api ` directory ` cd backend/api `
126+ - Configuration
127+ - Create local environment file ` cp .env.dev.example .env `
128+ - Modify ` .env ` for
129+ - PORT ` 8000 `
130+ - NODE_ENV ` development ` | ` production `
131+ - SECURITY_SECRET (Use [ passwordsgenerator] ( https://passwordsgenerator.net ) )
132+ - SECURITY_SALT_ROUNDS ` 10 `
133+ - MONGO_URL ` mongodb://localhost:27017/example `
134+ - LANDING_URL ` http://localhost:3000 `
135+ - WEB_URL ` http://localhost:5000 `
136+ - API_URL ` http://localhost:8000 `
137+ - EMAIL_ON ` 0 ` | ` 1 ` (in development, you can toggle to send emails or not)
138+ - EMAIL_TEST (send test emails to this address)
139+ - EMAIL_HOST, EMAIL_USER, EMAIL_PASSWORD (use any email servive, eg. [ mailgun.com] ( https://www.mailgun.com/ ) and get info to start sending emails
140+ - Setup
141+ - Install packages and seed database ` npm run setup `
142+ - Run
143+ - Start API server: ` npm start ` (http://localhost:8000 )
144+
118145- ** Landing**
119146 - Switch to ` landing ` directory ` cd frontend/landing `
120147 - Configuration
@@ -130,11 +157,22 @@ A typical product (SaaS, etc.) usually consists of following services:
130157 - Setup
131158 - Install dependencies: ` npm install `
132159 - Run
133- - Start Landing server: ` npm start ` , browse at http://localhost:3000 *
134- - Code
135- - Modular code base
136- -
137-
160+ - Start Landing server: ` npm start ` , browse at http://localhost:3000
161+
162+ - ** Web**
163+ - Switch to ` web ` directory ` cd frontend/app/web `
164+ - Configuration
165+ - Create local environment file ` cp .env.dev.example .env `
166+ - Modify ` .env ` for
167+ - PORT ` 5000 `
168+ - REACT_APP_LANDING_URL ` http://localhost:3000 `
169+ - REACT_APP_WEB_URL ` http://localhost:5000 `
170+ - REACT_APP_API_URL ` http://localhost:8000 `
171+ - Setup
172+ - Install dependencies: ` npm install `
173+ - Run
174+ - Start Web server: ` npm start ` , browse at http://localhost:5000
175+
138176
139177## Screenshots
140178
0 commit comments