You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Quick Start Guide: Added a quick start guide link.
Reason: To help users quickly set up and run the system without going through detailed documentation.
Advanced Setup Instructions: Added a link for detailed setup instructions.
Reason: To provide comprehensive guidance for users deploying the system in production environments.
Theming and Customization: Included a guide for frontend customization.
Reason: To assist users in personalizing their store’s appearance to match their branding.
API Reference: Enhanced the API reference section with a clearer description.
Reason: To make API documentation more accessible and useful for developers integrating Shopizer into their applications.
Community Support: Added a link and description for the Slack channel.
Reason: To encourage users to join the community, get support, and collaborate with other developers.
Prerequisite Applications: Listed essential applications required for running the system:
Java 11+: For backend services. Download Java
Maven: For building the project. Download Maven
Docker (optional): For containerized deployment. Download Docker
Summary: These updates make the documentation more comprehensive and user-friendly by providing clear instructions, required tools, and accessible resources. Users can now set up and contribute to the project more efficiently.
@@ -22,13 +22,22 @@ Headless commerce and Rest api for ecommerce
22
22
- Customer
23
23
- User
24
24
25
+
25
26
Shopizer Headless commerce consists of the following components:
26
27
27
28
- Spring boot Java / Spring boot backend
28
29
- Angular administration web application
29
30
- React JS front end application
30
31
32
+
Prerequisites
33
+
34
+
Before you begin, ensure you have the following installed on your system:
35
+
36
+
Java 11+ (tested with Java 11, 16, and 17)
37
+
38
+
Maven (for building the project)
31
39
40
+
Docker (optional, for containerized deployment)
32
41
33
42
See the demo: [**New demo on the way 2023]
34
43
-------------------
@@ -53,16 +62,28 @@ docker run \
53
62
```
54
63
55
64
56
-
3. Run react shop sample site
65
+
3. Run React Shop Sample Site
57
66
58
-
⋅⋅⋅ Requires the java backend to be running
67
+
⋅⋅⋅ Requires the Java backend to be running.
68
+
69
+
-**Reason**: The React Shop sample site interacts with the backend API to retrieve and display products, handle customer authentication, and process orders. Without the backend running, the frontend will not be able to fetch necessary data or execute actions.
70
+
71
+
-**Steps**:
72
+
1. Ensure the backend is running using the steps outlined in the previous section.
73
+
2. Run the following Docker command to start the React Shop sample site:
74
+
```bash
75
+
docker run \
76
+
-e "APP_MERCHANT=DEFAULT" \
77
+
-e "APP_BASE_URL=http://localhost:8080" \
78
+
-p 80:80 shopizerecomm/shopizer-shop-reactjs
79
+
```
80
+
81
+
- **Access**: Once the site is running, you can access it at [http://localhost:80](http://localhost:80).
82
+
83
+
- **Troubleshooting**: If the site does not load properly, check:
84
+
1. That the backend service is running without errors.
85
+
2. That there are no network conflicts on port `80` or `8080`.
59
86
60
-
```
61
-
docker run \
62
-
-e "APP_MERCHANT=DEFAULT"
63
-
-e "APP_BASE_URL=http://localhost:8080"
64
-
-p 80:80 shopizerecomm/shopizer-shop-reactjs
65
-
```
66
87
67
88
API documentation:
68
89
-------------------
@@ -118,13 +139,28 @@ Please read the instructions on how to connect to MySQL, configure an email serv
118
139
### Documentation:
119
140
-------------------
120
141
121
-
Documentation available <https://shopizer-ecommerce.github.io/documentation/>
142
+
### Documentation and Resources
143
+
144
+
1. **Official Documentation**:
145
+
- **Description**: Comprehensive guide covering setup, configuration, and advanced usage of Shopizer.
- **Description**: Explore all available API endpoints with examples and detailed descriptions. Ideal for developers integrating Shopizer into their applications.
150
+
- **Link**: [Shopizer API Documentation](https://app.swaggerhub.com/apis-docs/shopizer/shopizer-rest-api/3.0.1#/)
122
151
123
-
Api documentation <https://app.swaggerhub.com/apis-docs/shopizer/shopizer-rest-api/3.0.1#/>
152
+
3. **Community and Support**:
153
+
- **Slack Channel**:
154
+
- **Description**: Join the Shopizer community on Slack to ask questions, share feedback, and get support from other users and developers.
Please open a PR (pull request) in order to have your changes merged to the upstream
174
+
Contributing to Shopizer is simple and rewarding. Follow the steps below to get started:
175
+
176
+
1. **Fork the Repository**:
177
+
- **Description**: Create your own copy of the repository on your GitHub account by clicking the **Fork** button at the top-right of the repository page.
178
+
- **Why**: This ensures your changes don’t directly affect the original repository.
179
+
180
+
2. **Clone from Forked Repository**:
181
+
- **Description**: Download the forked repository to your local machine to start making changes.
0 commit comments