https://github.com/arpitgo4/node-react-scaffold
Full Stack microservice scaffold with Node.js, React.js, Redux, MongoDB, Docker-Compose & Kubernetes
https://github.com/arpitgo4/node-react-scaffold
docker docker-compose kubernetes mongodb nodejs reactjs redux
Last synced: 3 months ago
JSON representation
Full Stack microservice scaffold with Node.js, React.js, Redux, MongoDB, Docker-Compose & Kubernetes
- Host: GitHub
- URL: https://github.com/arpitgo4/node-react-scaffold
- Owner: arpitgo4
- License: gpl-3.0
- Created: 2019-03-01T11:57:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-05T16:00:48.000Z (over 7 years ago)
- Last Synced: 2025-01-01T16:27:14.219Z (over 1 year ago)
- Topics: docker, docker-compose, kubernetes, mongodb, nodejs, reactjs, redux
- Language: JavaScript
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node-React-Scaffold [](https://travis-ci.org/arpitgo4/React-Redux-Scaffold)
Full stack javascript scaffold with MongoDB-Express-React-Node (MERN). Scaffold supports production and development modes, with **Best Developer Experience** ( DX ) by Hot-Reloading for the server side and client side changes. Docker, Typescript and production best practices are all baked in. Deployment script are provided for development and production environments with Docker-Compose and Kubernetes respectively.
## Scaffold Structure
```
.
├── api-gateway # Nginx Api Gateway
├── db # MongoDB data directory
├── deployment # Deployment config
| ├── development # Docker-compose development config
| └── production # Kubernetes production config
├── .env # environment variables
├── .gitignore # git commit ignore files
├── README.md # This file
└── setup.js # Scaffold setup script
```
## Environment Variables
```
## Environment variables are defined in the deployment/development/docker-compose.yml
## Environment variables are needed for successfull startup of the server
SERVER_PORT=8080 # Port number for server to listen
MONGO_HOST=mongo_cluster_ip:27017 # MongoDB connection url
MONGO_DB_NAME=express-mongodb # MongoDB database name
REDIS_HOST=redis_cluster_ip:6379 # Redis connection url
JWT_SECRET= # Secret for signing JWT tokens
JWT_HEADER=x-token # Request header for JWT tokens
JWT_TOKEN_TTL=20m # JWT token time to live
## Environment variables are needed for successfull startup of the client
## TODO
```
## Development
```
# Start client in development mode with hot code loading,
cd deployment/development && docker-compose up --build [-d]
# See logs for a container (service in docker-compose)
cd deployemnt/development && docker-compose logs --follow
# Get container (service) shell access
cd deployment/development && docker-compose exec sh
# Open web browser at [for api-server] http://localhost/api/v1/health
# Open web browser at [for react-app] http://localhost
# Enjoy developing :)
```
## Production
```
## TODO
# Docker image build
docker build -t express-mongodb-scaffold .
# Start the project
docker run --rm --name express-mongodb-scaffold -d -p 8080:8080 express-mongodb-scaffold
# Open web browser at http://localhost/api/v1/health
# You will see a sample Single Page Application
```
## Feedback
In case of any query or feedback, please feel free to connect via
* arpit.go4@gmail.com (Arpit Goyal)
Or, open an issue at github.