Skip to content

Commit aceacad

Browse files
authored
Update README.md
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.
1 parent 42e5937 commit aceacad

File tree

1 file changed

+111
-37
lines changed

1 file changed

+111
-37
lines changed

README.md

Lines changed: 111 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,22 @@ Headless commerce and Rest api for ecommerce
2222
- Customer
2323
- User
2424

25+
2526
Shopizer Headless commerce consists of the following components:
2627

2728
- Spring boot Java / Spring boot backend
2829
- Angular administration web application
2930
- React JS front end application
3031

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)
3139

40+
Docker (optional, for containerized deployment)
3241

3342
See the demo: [**New demo on the way 2023]
3443
-------------------
@@ -53,16 +62,28 @@ docker run \
5362
```
5463

5564

56-
3. Run react shop sample site
65+
3. Run React Shop Sample Site
5766

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`.
5986

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-
```
6687

6788
API documentation:
6889
-------------------
@@ -118,13 +139,28 @@ Please read the instructions on how to connect to MySQL, configure an email serv
118139
### Documentation:
119140
-------------------
120141

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.
146+
- **Link**: [Shopizer Documentation](https://shopizer-ecommerce.github.io/documentation/)
147+
148+
2. **API Documentation**:
149+
- **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#/)
122151

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.
155+
- **Link**: [Join Slack Channel](https://communityinviter.com/apps/shopizer/shopizer)
156+
- **ChatOps**:
157+
- **Description**: Direct link to the Shopizer workspace on Slack for real-time discussions.
158+
- **Link**: [Shopizer Slack Workspace](https://shopizer.slack.com)
124159

125-
ChatOps <https://shopizer.slack.com> - Join our Slack channel <https://communityinviter.com/apps/shopizer/shopizer>
160+
4. **Official Website**:
161+
- **Description**: Learn more about Shopizer, including news, updates, and additional resources.
162+
- **Link**: [Shopizer Website](http://www.shopizer.com)
126163

127-
More information is available on shopizer web site here <http://www.shopizer.com>
128164

129165
### Participation:
130166
-------------------
@@ -135,30 +171,68 @@ so we can send an invite to our Slack channel
135171

136172
### How to Contribute:
137173
-------------------
138-
Fork the repository to your GitHub account
139-
140-
Clone from fork repository
141-
-------------------
142-
143-
$ git clone https://github.com/yourusername/shopizer.git
144-
145-
Build application according to steps provided above
146-
147-
Synchronize lastest version with the upstream
148-
-------------------
149-
150-
$ git remote add upstream https://github.com/yourusername/shopizer.git
151-
$ git pull upstream 3.2.5
152-
153-
Create new branch in your repository
154-
-------------------
155-
156-
$ git checkout -b branch-name
157-
158-
159-
Push your changes to Shopizer
160-
-------------------
161-
162-
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.
182+
- **Command**:
183+
```bash
184+
git clone https://github.com/yourusername/shopizer.git
185+
cd shopizer
186+
```
187+
188+
3. **Build the Application**:
189+
- **Description**: Ensure that the application builds successfully and is ready for development or testing.
190+
- **Steps**:
191+
- Follow the [Build Steps](#installation-guide) provided earlier in this README.
192+
193+
4. **Synchronize with the Upstream Repository**:
194+
- **Description**: Keep your fork updated with the latest changes from the main repository.
195+
- **Commands**:
196+
```bash
197+
git remote add upstream https://github.com/shopizer-ecommerce/shopizer.git
198+
git pull upstream 3.2.5
199+
```
200+
- **Why**: Synchronizing ensures your changes are compatible with the latest version of the project.
201+
202+
5. **Create a New Branch**:
203+
- **Description**: Always create a new branch for your feature or fix to keep your work organized.
204+
- **Command**:
205+
```bash
206+
git checkout -b branch-name
207+
```
208+
- **Tip**: Use descriptive branch names like `feature-add-product-filter` or `fix-cart-bug`.
209+
210+
6. **Make Your Changes**:
211+
- **Description**: Implement the feature, fix the bug, or update the documentation.
212+
213+
7. **Test Your Changes**:
214+
- **Description**: Run the application locally and ensure your changes work as intended without breaking existing functionality.
215+
- **Tip**: Use tools like Swagger UI to test API changes.
216+
217+
8. **Push Changes to Your Fork**:
218+
- **Description**: Push your changes to your forked repository on GitHub.
219+
- **Command**:
220+
```bash
221+
git push origin branch-name
222+
```
223+
224+
9. **Submit a Pull Request (PR)**:
225+
- **Description**: Request to merge your changes into the main repository.
226+
- **Steps**:
227+
- Navigate to your forked repository on GitHub.
228+
- Click the **Compare & Pull Request** button.
229+
- Add a clear title and description explaining your changes.
230+
- **Tip**: Mention any related issues (e.g., \"Fixes #123\") in the description.
231+
232+
10. **Respond to Feedback**:
233+
- **Description**: Be prepared to make updates or revisions based on feedback from maintainers.
234+
- **Why**: Collaboration ensures your contribution meets project standards.
235+
236+
---
163237

164238

0 commit comments

Comments
 (0)