Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gab-cat/merchtrack
The MerchTrack Repository is a comprehensive solution designed for an e-commerce platform that streamlines order management, payment processing, reporting, order tracking, and merchandise fulfillment for organizations.
https://github.com/gab-cat/merchtrack
clerk-auth docker nextjs postgresql prisma redis shadcn-ui tailwindcss tanstack-query typescript zod zustand
Last synced: about 10 hours ago
JSON representation
The MerchTrack Repository is a comprehensive solution designed for an e-commerce platform that streamlines order management, payment processing, reporting, order tracking, and merchandise fulfillment for organizations.
- Host: GitHub
- URL: https://github.com/gab-cat/merchtrack
- Owner: gab-cat
- License: mit
- Created: 2025-01-01T17:19:59.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-02-02T14:21:21.000Z (1 day ago)
- Last Synced: 2025-02-02T14:33:05.270Z (1 day ago)
- Topics: clerk-auth, docker, nextjs, postgresql, prisma, redis, shadcn-ui, tailwindcss, tanstack-query, typescript, zod, zustand
- Language: TypeScript
- Homepage: https://staging.merchtrack.tech
- Size: 963 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# MerchTrack Repository
## Introduction
The **MerchTrack Repository** is a comprehensive solution designed for an e-commerce platform that streamlines order management, payment processing, reporting, order tracking, and merchandise fulfillment for organizations. This repository leverages modern technologies and best practices to ensure scalability, maintainability, and a seamless developer experience.
---
## Installation
### Prerequisites
Before setting up the project, ensure the following tools and versions are installed:
- **Node.js**: Version `22.12.0` is strictly required. It is recommended to use `nvm` (Node Version Manager) for managing Node.js versions.
- If you do not have `nvm` installed yet. Refer to this guide [Node Version Manager Installation](https://www.freecodecamp.org/news/node-version-manager-nvm-install-guide/)
- **Package Manager**: Use `pnpm` for faster and more efficient dependency management.
### Setup Steps
1. **Install Node.js**:
Use `nvm` to install and switch to the required Node.js version:
```sh
nvm install 22.12.0
nvm use 22.12.0
```
2. **Install Dependencies**:
Install project dependencies using `pnpm`:
```sh
npm install -g pnpm
pnpm install
```
3. **Environment Configuration**:
Obtain the `.env` files for production from the system administrator. These files contain sensitive configuration details such as API keys and database credentials.
Example `.env` file:
```env
DATABASE_URL="postgresql://user:password@localhost:5432/merchtrack"
CLERK_SECRET_KEY="sk_test_xxxxxxxxxxxxxxxx"
```
4. **Run the Development Server**:
Start the development server to begin working on the project:
```sh
pnpm run dev
```
## Further Reading
For more detailed information, please refer to the following sections in our wiki:
| Topic | Description | Link |
|----------------------|-----------------------------------------------------------------------------|----------------------------------------------------------------------|
| Home/Milestones | Overview and milestones of the project | https://github.com/gab-cat/merchtrack/wiki |
| Conventions | Coding conventions and best practices | https://github.com/gab-cat/merchtrack/wiki/Conventions |
| Folder Structure | Detailed explanation of the project's folder structure | https://github.com/gab-cat/merchtrack/wiki/Folder-Structure |
| Git Flow | Guidelines for using Git in this project | https://github.com/gab-cat/merchtrack/wiki/Git-Flow |
| Tech Stack | Information about the technologies and tools used in the project | https://github.com/gab-cat/merchtrack/wiki/Tech-Stack-&-Tools |
| VSCode Extensions | Recommended Visual Studio Code extensions for development | https://github.com/gab-cat/merchtrack/wiki/VS-Code-Extensions |