https://github.com/moovweb/react-storefront-boilerplate
A starter project for apps built with react-storefront
https://github.com/moovweb/react-storefront-boilerplate
Last synced: 9 months ago
JSON representation
A starter project for apps built with react-storefront
- Host: GitHub
- URL: https://github.com/moovweb/react-storefront-boilerplate
- Owner: moovweb
- Created: 2018-10-17T19:01:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-29T16:06:48.000Z (about 3 years ago)
- Last Synced: 2025-04-07T21:40:51.512Z (about 1 year ago)
- Language: JavaScript
- Size: 6.49 MB
- Stars: 19
- Watchers: 21
- Forks: 8
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Storefront Boilerplate
For detailed documentation, see the [React Storefront Docs](https://pwa.moovweb.com).
## Setup
First, install the dependencies:
```
npm install
```
## Running (Moovweb XDN SDK)
```
npm start
```
This builds and starts your application on [https://localhost:8080](https://localhost:8080) using the Moovweb XDN SDK. Once the build is complete, your browser will automatically open and display the application.
## Running (Express)
You can also run you app using express:
```
npm start:express
```
## Windows
To run this project on Windows:
```
yarn start:windows
```
## Creating a new Project
### Clone the repo into a directory
```
git clone git@github.com:moovweb/react-storefront-boilerplate.git
cd
```
### Local Config
Update the host_map in moov_config-local.json to use the customer's domain name. Replace `domain.com` in the code below with the customer's actual domain name. The customer will need to create a DNS entry for the "dev-origin" subdomain.
```
"host_map": [
"domain.com => dev-origin.domain.com"
]
```
### Development Server Config
Update the host map in moov_config-dev.json. Here we typically use dev.domain.com. **Make sure that the subdomain you use is not already in use by the customer.**
```
"host_map": [
"pwa-dev.domain.com => dev-origin.domain.com"
]
```
### Production Server Config
Update the host map in moov_config-prod.json. The customer will need to create a DNS entry for the origin subdomain.
```
"host_map": [
"domain.com => origin.domain.com"
]
```
### Package.json
Edit the name in package.json. Use `-pwa`.
### Moovweb Console
Create the development environment in the [Moovweb Console](https://console.moovweb.com):
1. Click "Create New Project"
2. Enter a name and select "Single Domain". We suggest `-pwa-dev`
3. Select "Project Settings"
4. Select "Internal Config"
5. Set "Service Level" to "Enterprise Production"
### GitHub
Create a new repo in [Moovweb Projects](https://github.com/organizations/moovweb-projects/repositories/new) and copy the SSH url. We suggest naming the repo `-pwa`.
In the repo settings, under "Collaborators and Teams" add "Engineering Team" and grant write access.
In the root of your local clone, run the following to re-initialize the git repo and push it up to GitHub:
```
rm -rf .git
git init
git add .
git commit -am "initial commit"
git remote add origin (paste SSH git url from repo)
git push -u origin master
```
### Circle CI
Open .circleci/config.yml. Search for "moov deploy" and update the command to use the correct environment name:
```
moov deploy /-pwa-dev
```
Commit and push to origin
The configure the project in [Circle CI - Moovweb Projects](https://circleci.com/gh/moovweb-projects):
1. Click "Add Projects"
2. Find your repo and click "Set Up Project"
3. Edit the project settings and select "Environment Variables".
4. Add your moov console credentials as MOOV_EMAIL and MOOV_PASSWORD.
5. Select "Overview", then "Start Building" at the bottom.
Lastly, start a build and ensure that it succeeds.