Opinionated project architecture for Full-Stack JavaScript Applications.
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).
A typical product (SaaS, etc.) usually consists of following services:
-
Landing page
- Used for introducing your business to customers
- Provide links to download the mobile application
- Provide link to access web application
- Contact page
- Privacy policy page
- Terms of use page
- SEO friendly (should support server side rendering)
-
Web Application
- Your actual application for your customers to use
- Desktop browser
- Tablet and mobile browser via responsive design
-
Mobile Application
- Your actual application for your customers to use
- Android (Mobile/Tablet)
- iOS (Mobile/Tablet)
fsja
├── backend
│ ├── api
│ │ > NodeJS
│ │ > PORT 8000
│ │ > api.example.com
│ │
│ ├── database
│ │ > MongoDB
│ │ > PORT 27017
│ │
│ └── proxy
│ > NGINX
│
├── deployment
│ > Docker Compose
│
├── frontend
│ ├── app
│ │ ├── mobile
│ │ │ > React Native
│ │ │ > iOS (Apple App Store)
│ │ │ > Android (Google Play Store)
│ │ │
│ │ └── web
│ │ > React
│ │ > Single page application
│ │ > PORT 5000
│ │ > app.example.com
│ │
│ └── landing
│ > React
│ > Server side rendered
│ > PORT 3000
│ > example.com
│
└── README.md (you are here)
- API
- Technologies
- NodeJS
- Express
- Technologies
- Database
- Technologies
- MongoDB
- Technologies
- Proxy
- Technologies
- NGINX
- Technologies
-
Landing
- Technologies
- NodeJS
- Express
- React
- React Router
- Server Side Rendering
- Material UI
- Technologies
-
Web
- Technologies
- React
- Redux
- React Router
- Server Side Rendering
- Material UI
- Technologies
-
Mobile (iOS, Android)
- Technologies
- React Native
- Redux
- React Navigation
- Technologies
- Technologies
- Docker
- Docker compose
-
Prerequisites
- Node (
v10.x
) - MongoDB (
v4.x
) - Xcode (for iOS) (latest)
- Android Studio (for Android) (latest)
- Follow React Native Guide to setup your local machine
- Node (
-
Clone repo
git clone git@github.com:atulmy/fullstack-javascript-architecture.git fullstack
-
API
- Info
- Switch to
api
directorycd backend/api
- Configuration
- Create local environment file
cp .env.dev.example .env
- Modify
.env
forPORT
(8000
)NODE_ENV
(development
|production
)SECURITY_SECRET
(Use passwordsgenerator)SECURITY_SALT_ROUNDS
(10
)MONGO_URL
(mongodb://localhost:27017/example
)LANDING_URL
(http://localhost:3000
)WEB_URL
(http://localhost:5000
)API_URL
(http://localhost:8000
)EMAIL_ON
(0
|1
(in development, you can toggle to send emails or not))EMAIL_TEST
(send test emails to this address)EMAIL_HOST
,EMAIL_USER
,EMAIL_PASSWORD
(use any email servive, eg. mailgun.com and get info to start sending emails
- Create local environment file
- Setup
- Install packages and seed database
npm run setup
- Install packages and seed database
- Run
- Start API server:
npm start
(http://localhost:8000)
- Start API server:
-
Landing
- Switch to
landing
directorycd frontend/landing
- Configuration
- Create local environment file
cp .env.dev.example .env
- Modify
.env
forPORT
(3000
)NODE_ENV
(development
|production
)LANDING_URL1 (
http://localhost:3000`)WEB_URL
(http://localhost:5000
)API_URL
(http://localhost:8000
)CONTACT_PHONE
,CONTACT_EMAIL
,CONTACT_ADDRESS
(your contact information)GA_TRACKING_ID
(Google analytics tracking ID)
- Create local environment file
- Setup
- Install dependencies:
npm install
- Install dependencies:
- Run
- Start Landing server:
npm start
, browse at http://localhost:3000
- Start Landing server:
- Resources
- Use getterms.io to generate Privacy Policy / Terms of Use
- Favicon generator realfavicongenerator
- Switch to
-
Web
- Switch to
web
directorycd frontend/app/web
- Configuration
- Create local environment file
cp .env.dev.example .env
- Modify
.env
forPORT
(5000
)REACT_APP_LANDING_URL
(http://localhost:3000
)REACT_APP_WEB_URL
(http://localhost:5000
)REACT_APP_API_URL
(http://localhost:8000
)
- Create local environment file
- Setup
- Install dependencies:
npm install
- Install dependencies:
- Run
- Start Web server:
npm start
, browse at http://localhost:5000
- Start Web server:
- Switch to
-
Deployment
- Deploy code
- Login to the server (SSH)
- Switch to
deployment
directorycd deployment
- Pull latest code
git pull
- Build containers
docker-compose up --build -d
up
= Builds, (re)creates, starts, and attaches to containers for a service.--build
= Build images before starting containers-d
= Detached mode: Run containers in the background, print new container names
- Resources - Set Up Free SSL Certificates from Let's Encrypt using Docker and Nginx
- Deploy code
-
Mobile
- Switch to
mobile
directorycd frontend/app/mobile
- Configuration
- Create local environment file
cp .env.dev.example .env
- Modify
.env
forAPP_ID
(com.example
(your app bundle ID))APP_VERSION
(0.0.1
(increment this for each publish on App or Play Store))APP_BUILD
(1
(increment this for each publish on App or Play Store))APP_ENV
(development
|production
)LANDING_URL
(http://<your local network IP>:3000
)WEB_URL
(http://<your local network IP>:5000
)API_URL
(http://<your local network IP>:8000
)- Tip: use
ifconfig
on macOS or Linux to get your local IP address
- Create local environment file
- Setup
- Install dependencies:
npm install
- Install dependencies:
- Run
- iOS
ENVFILE=.env react-native run-ios --simulator='iPhone 8'
- Android
ENVFILE=.env react-native run-android
(connect your Android phone via USB or use already created simulator with nameMobile_-_5
by runningcd ~/Library/Android/sdk/tools && ./emulator -avd Mobile_-_5
)
- iOS
- Publish
- Android
- Build:
. ./.env.production && cd android && ./gradlew assembleRelease && cd ..
. - Upload
frontend/app/mobile/android/app/build/outputs/apk/release/app-release.apk
to Play Store.
- Build:
- iOS
- Build: Open
frontend/app/mobile/ios/example.xcodeproj
in Xcode -> Choose Generic iOS Device (top left) -> Product (top menu) -> Archive. - Upload using Archiver (will open automatically once Arhive is complete)
- Build: Open
- Android
- Resources
- From react-native init to app stores real quick
- iOS App icon and splashscreen generator appicon
- Icon generator makeappicon
- Icons and splashscreen generator imagegorilla
- Switch to
View all screenshots here.
Landing | |
Web | |
Mobile | |
- Atul Yadav - GitHub · Twitter
- [YOUR NAME HERE] - Feel free to contribute to the codebase by resolving any open issues, refactoring, adding new features, writing test cases or any other way to make the project better and helpful to the community. Feel free to fork and send pull requests.
Looking for a developer to build your next idea or need a developer to work remotely? Get in touch: atul.12788@gmail.com
Copyright (c) 2018 Atul Yadav http://github.com/atulmy
The MIT License (http://www.opensource.org/licenses/mit-license.php)