Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alireza-akbarzadeh/commento
This project is designed to create a comprehensive marketplace platform that connects users with various sellers and stores, whether online or offline. The goal is to provide a seamless experience for users to discover products, compare prices, and find nearby merchants, making shopping convenient and accessible.
https://github.com/alireza-akbarzadeh/commento
bun nextjs react shadcn-ui tailwindcss typescript vitest
Last synced: 3 months ago
JSON representation
This project is designed to create a comprehensive marketplace platform that connects users with various sellers and stores, whether online or offline. The goal is to provide a seamless experience for users to discover products, compare prices, and find nearby merchants, making shopping convenient and accessible.
- Host: GitHub
- URL: https://github.com/alireza-akbarzadeh/commento
- Owner: alireza-akbarzadeh
- Created: 2024-07-04T19:34:58.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-09-10T17:19:19.000Z (4 months ago)
- Last Synced: 2024-09-10T19:31:54.347Z (4 months ago)
- Topics: bun, nextjs, react, shadcn-ui, tailwindcss, typescript, vitest
- Language: TypeScript
- Homepage: https://it-bazar.vercel.app
- Size: 14.5 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
- Contributing: docs/CONTRIBUTING.md
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: docs/CODEOWNERS
- Security: docs/SECURITY.md
- Support: docs/SUPPORT.md
Awesome Lists containing this project
README
Commento
## Table of Contents
- [Introduction](#introduction)
- [Getting Started](#getting-started)
- [Development Tools](#development-tools)
- [Scripts Overview](#scripts-overview)
- [UI Components](#ui-components)
- [Code Quality](#code-quality)
- [Deployment](#deployment)
- [Contributing](#contributing)
- [License](#license)
## Introduction
Commento is a marketplace for buying and selling products, designed to provide a seamless experience for users.
## Getting Started
To get started with Commento, follow these steps:
1. Ensure you have [Bun](https://bun.sh/docs/installation) installed (version 1.1.24 recommended).
2. Fork & clone the repository:
```bash
git clone https://github.com//commento.git
2. Install the dependencies:
```bash
bun install
```
3. Run the development server:
```bash
bun dev
```
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Development tools
- **Bun**: JavaScript runtime and package manager (version 1.1.24)
- **Node.js**: JavaScript runtime (version 22.0.0)
- **Next.js**: React framework for building web applications
- **React**: JavaScript library for building user interfaces
- **TypeScript**: Typed superset of JavaScript for enhanced development experience
- **Tailwind CSS**: Utility-first CSS framework for rapid UI development
- **Shadcn/ui**: Reusable components built using Radix UI and Tailwind CSS
- **Storybook**: Tool for developing and showcasing UI components in isolation
- **ESLint**: Pluggable linter for Next.js and TypeScript
- **Prettier**: Opinionated code formatter for consistent code style
- - **Zod**: TypeScript-first schema validation library
- **Iconmoon**: Icon set for beautifully simple, pixel-perfect icons
- **Vazirmatn**: Custom font optimized for performance
- **ImageResponse**: React component for lazy loading images and other elements
- **Netlify**: Platform for continuous deployment and hosting
## 📃 Scripts Overview
The following scripts are available in the `package.json`:
- `dev`: Starts the development server with colorized output
- `build`: Builds the app for production
- `start`: Starts the production server
- `format`: Formats the code with Prettier
- `lint`: Lints the code using ESLint
- `lint:fix`: Automatically fixes linting errors
- `prettier`: Checks the code for proper formatting
- `prettier:fix`: Automatically fixes formatting issues
- `story`: Starts the Storybook server
- `build-story`: Builds the Storybook for deployment
### UI
- [Tailwind CSS](https://tailwindcss.com/) – Utility-first CSS framework for rapid UI development
- [Shadcn/ui](https://ui.shadcn.com/) – Re-usable components built using Radix UI and Tailwind CSS
- [iconmoon](https://icomoon.io/) – Beautifully simple, pixel-perfect icons
- [`vazirmatn`](https://github.com/rastikerdar/vazirmatn) – Optimize custom fonts and remove external network requests for improved performance
- [`ImageResponse`](https://github.com/rastikerdar/vazirmatn) – React Component to lazy load images and other components/elements. Supports IntersectionObserver and includes a HOC to track window scroll position to improve performance.
### Code Quality
- [TypeScript](https://www.typescriptlang.org/) – Static type checker for end-to-end typesafety
- [Prettier](https://prettier.io/) – Opinionated code formatter for consistent code style
- [ESLint](https://eslint.org/) – Pluggable linter for Next.js and TypeScript
## 🚀 Deployment
[](https://app.netlify.com/sites/it-bazar/deploys)
### Contributing
The devtools community is possible thanks to thousands of kind volunteers like you. We welcome all contributions to the community and are excited to welcome you aboard.
Recent Contributions:
