kara-shop

(โ˜… 379)

KARA - Ecommerce built with T3 Stack : NextJS, TypeScript, tRPC, Prisma, NextAuth and styled with Tailwind CSS

  • .dockerignore
  • .editorconfig
  • .env.example
  • .eslintrc.json
  • .gitignore
  • .lintstagedrc.js
  • commitlint.config.js
  • cypress.config.ts
  • docker-compose.yml
  • Dockerfile
  • jest.config.js
  • LICENCE
  • next-env.d.ts
  • next-i18next.config.js
  • next-seo.config.ts
  • next.config.mjs
  • package.json
  • pnpm-lock.yaml
  • postcss.config.js
  • prettier.config.cjs
  • README.md
  • renovate.json
  • tailwind.config.js
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/mehrabmp/kara-shop

Downloads the entire project code from GitHub to your computer.

cd kara-shop

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
pnpm install

Downloads and installs the libraries listed in package.json.

pnpm migrate-dev

Type this command into your terminal and run it.

pnpm db-seed

Type this command into your terminal and run it.

pnpm dev

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation