https://github.com/broadleafcommerce/reactstarter
Broadleaf Commerce Spring Boot React Starter
https://github.com/broadleafcommerce/reactstarter
Last synced: about 1 year ago
JSON representation
Broadleaf Commerce Spring Boot React Starter
- Host: GitHub
- URL: https://github.com/broadleafcommerce/reactstarter
- Owner: BroadleafCommerce
- License: cc0-1.0
- Created: 2017-08-28T19:30:31.000Z (almost 9 years ago)
- Default Branch: develop-5.2.x
- Last Pushed: 2024-11-19T18:32:49.000Z (over 1 year ago)
- Last Synced: 2025-03-31T12:09:04.560Z (about 1 year ago)
- Language: JavaScript
- Size: 15.7 MB
- Stars: 43
- Watchers: 22
- Forks: 42
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## Broadleaf Commerce Spring Boot React Starter
This Maven project is meant to be used as a solid starter project for any [Broadleaf Commerce](http://www.broadleafcommerce.org) application.
It has many sensible defaults set up along with examples of how a fully functioning eCommerce site based on Broadleaf might work.
This project differs from [Demo Site](https://github.com/BroadleafCommerce/DemoSite) in that it uses React and NodeJS for the `site` application and interacts with Broadleaf through the `api` application. This is a good starting point for anyone looking to use Broadleaf for a single-page application.
## Environment Setup
The `site` application requires your environment to have NodeJS and Yarn installed. You will need to download and install both
of these to your environment.
NodeJS can be found and downloaded at https://nodejs.org/en/.
You can find the instructions to install Yarn at https://yarnpkg.com/en/docs/install. Mac users can run `brew install yarn`.
## Running the applications
This starter contains several runnable applications: `site`, `admin`, and `api`.
You can run `admin` and `api` as any other Spring Boot application (http://docs.spring.io/spring-boot/docs/current/reference/html/using-boot-running-your-application.html)
These applications automatically configure and start an HSQL DB and SOLR instance (if not already configured).
By default, these will be located in your `java.io.tmp` directory.
### Running the `api` application
This application needs to be the first to run since the `site` application is dependent on the `api` application. You can run
this application by using the Spring Boot Maven Plugin::
```
> cd
> mvn clean install
> cd api
> mvn spring-boot:run
```
> Note: Default debug port open on `8085`
### Running the `site` application
The `site` application is a runnable NodeJS application. You will need to be sure to be running the `api` application first,
as the `site` application is not functional without the `api`.
Starting up the `site` application requires you to install the dependencies and then running the webpack dev server.
```
> cd site
> yarn
> yarn develop
```
### Running the `admin` application
```
> cd admin
> mvn spring-boot:run
```
> Note: Default debug port open on `8084`
## License
Broadleaf Commerce React Starter
Written in 2017 by Broadleaf Commerce info@broadleafcommerce.com
To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see .
Please Note - The scope of CC0 Public Domain Dedication extends to Broadleaf Commerce React Starter demo application alone. Linked libraries (including all Broadleaf Commerce Framework libraries) are subject to their respective licenses, including the requirements and restrictions specified therein.