Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkloz/online-store-frontend
https://github.com/mkloz/online-store-frontend
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mkloz/online-store-frontend
- Owner: mkloz
- Created: 2024-07-24T18:30:11.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-20T16:29:21.000Z (5 months ago)
- Last Synced: 2024-08-20T18:55:37.353Z (5 months ago)
- Language: TypeScript
- Homepage: https://online-store.mkloz.online/
- Size: 11.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
CITYWHEELS(ONLINE-STORE)
Buy new wheels for yourself and move with pleasure
Developed with the software and tools below.
## 🔗 Quick Links
> - [📍 Overview](#-overview)
> - [🚀 Getting Started](#-getting-started)
> - [⚙️ Installation](#️-installation)
> - [🤖 Running online-store-frontend](#-running-online-store-frontend)
> - [🤝 Contributing](#-contributing)
> - [📄 License](#-license)
> - [👏 Acknowledgments](#-acknowledgments)
---
## 📍 Overview
Welcome to Citywheels! We offer a wide range of wheels for various purposes, including bicycles, skateboards, scooters, monowheels, and more.
Our store is developed using a combination of JavaScript, React, Next.js, and TypeScript. We follow best practices and use tools like Prettier and ESLint to ensure clean and consistent code. Our frontend is built with Tailwind CSS for a modern and responsive design.
Feel free to explore our repository structure to get a better understanding of how our project is organized. We have various components, forms, icons, and UI elements that contribute to the overall functionality and user experience of our online store.
If you have any questions or need assistance, please don't hesitate to reach out. Happy shopping!
---
## 🚀 Getting Started
### ⚙️ Installation
1. Clone the online-store-frontend repository:
```sh
git clone https://github.com/mkloz/online-store-frontend
```
2. Change to the project directory:
```sh
cd online-store-frontend
```
3. Install the dependencies:
```sh
npm install
```
### 🤖 Running online-store-frontend
Use the following command to run online-store-frontend:
```sh
npm run build && node dist/main.js
```
## 🤝 Contributing
Contributions are welcome! Here are several ways you can contribute:
- **[Submit Pull Requests](https://github.com/mkloz/online-store-frontend/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
- **[Join the Discussions](https://github.com/mkloz/online-store-frontend/discussions)**: Share your insights, provide feedback, or ask questions.
- **[Report Issues](https://github.com/mkloz/online-store-frontend/issues)**: Submit bugs found or log feature requests for Online-store-frontend.
Contributing Guidelines
1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
2. **Clone Locally**: Clone the forked repository to your local machine using a Git client.
```sh
git clone https://github.com/mkloz/online-store-frontend
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to GitHub**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Once your PR is reviewed and approved, it will be merged into the main branch.
---
## 📄 License
This project is protected under the [MIT](/LICENCE) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/mit) file.
---
## 👏 Acknowledgments
- Thanks to designers I was able to create this ui only in 6 weeks.
[**Return**](#-quick-links)
---