https://github.com/peterkibuchi/soko-merchant
Soko is a powerful ecommerce platform for seamless online store management and a secure, user-friendly shopping experience.
https://github.com/peterkibuchi/soko-merchant
Last synced: about 1 year ago
JSON representation
Soko is a powerful ecommerce platform for seamless online store management and a secure, user-friendly shopping experience.
- Host: GitHub
- URL: https://github.com/peterkibuchi/soko-merchant
- Owner: peterkibuchi
- Created: 2023-10-09T03:57:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-11T04:04:25.000Z (about 2 years ago)
- Last Synced: 2024-05-11T17:42:01.012Z (about 2 years ago)
- Language: TypeScript
- Homepage: https://soko-merchant.vercel.app
- Size: 1.94 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Soko
> Soko is a powerful ecommerce platform for seamless online store management and a secure, user-friendly shopping experience.
## Table of Contents
- [General Information](#general-information)
- [Technologies Used](#technologies-used)
- [Meta-Features](#meta-features)
- [Quickstart](#quickstart)
- [Project Status](#project-status)
## General Information
- Soko is an ecommerce platform that allows users to seamlessly create and manage an online store, and to provide shoppers with a secure and convenient buying experience.
- It comprises two applications:
1. A [merchant](https://github.com/peterkibuchi/soko-merchant) web application for store and product management.
2. A [consumer](https://github.com/peterkibuchi/soko-consumer) web application for browsing and purchasing various products.
## Technologies Used
- React 18
- Next.js 14
- Clerk Auth
- Drizzle ORM
- Shadcn UI
- Tailwind CSS
- TypeScript
- tRPC
## Meta-Features
- Next.js `/app` dir
- React Client and Server Components
- Metadata configuration for improved SEO and web shareability
- Data fetching and mutation with Tanstack React Query
- Schema declarations and validations with Zod
- Typesafe code and best practices made possible by TypeScript, ESLint and Prettier
- Automated `format`, `lint` and `typecheck` CI steps with GitHub Actions
- ... and much more
## Quickstart
To run it locally, follow the steps below:
1. Clone repository and install the dependencies:
```bash
# Clone repository
git clone git@github.com:peterkibuchi/soko-merchant.git
# Install dependencies
pnpm i
```
2. Copy `.env.example` to `.env` and update the variables.
```bash
cp .env.example .env
```
3. Sync the Drizzle schema with your database
```bash
pnpm db:push
```
4. Start the development server:
```bash
pnpm dev
```
## Project Status
Soko is currently: _in development_.