https://github.com/seniru/defendxstore
https://github.com/seniru/defendxstore
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/seniru/defendxstore
- Owner: Seniru
- Created: 2025-02-25T03:50:28.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2025-02-25T08:02:04.000Z (3 months ago)
- Last Synced: 2025-02-25T09:19:29.836Z (3 months ago)
- Language: JavaScript
- Size: 563 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Defendxstore
> E-commerce platform for DefendX clothing store. This project was implemented as per requirements of SLIIT Software Engineering degree.
This app is created using the **MERN** stack.
## Requirements
- Node.js
- mongod (and optionally mongosh), if running the database instances locally.
## Setting up
Run the following commands to set up the application locally.
```sh
# Clone the repository into local machine
git clone https://github.com/Seniru/defendxstore
# Navigate to the project directory
cd defendxstore
```
Follow instructions provided in [backend](./backend/README.md) and [frontend](./frontend/README.md) to setup each of those components.
## Contributing
- Fork this repository
- Create a new branch for your feature. `feature-auth` for example.
```bash
git checkout -b feature-your-feature-name
```
- Commit your changes. Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) style when creating commits. `feat: add login button` for example.
- Push your changes
```bash
git push
```
- Create a pull request