An open API service indexing awesome lists of open source software.

https://github.com/juliusmarkwei/azubi-commerce


https://github.com/juliusmarkwei/azubi-commerce

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# Azubi Commerce

A modern e-commerce platform built with Next.js, React, and Tailwind CSS.

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Next.js](https://img.shields.io/badge/Next.js-14.2.29-000000?logo=next.js)](https://nextjs.org/)
[![React](https://img.shields.io/badge/React-18.3.1-61DAFB?logo=react&logoColor=white)](https://reactjs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.8.3-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
[![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-3.4.17-06B6D4?logo=tailwind-css&logoColor=white)](https://tailwindcss.com/)
[![pnpm](https://img.shields.io/badge/pnpm-10.11.0-F69220?logo=pnpm&logoColor=white)](https://pnpm.io/)

## 🚀 Features

- **Modern Stack**: Built with Next.js 14, React 18, and TypeScript
- **Fast by Default**: Optimized for performance and SEO
- **Responsive Design**: Works on all devices with Tailwind CSS
- **Developer Experience**: Great DX with TypeScript and ESLint
- **Package Management**: Using pnpm for fast, disk space efficient package management

## 🛠️ Prerequisites

- Node.js 18 or later
- pnpm 8 or later

## 🚀 Getting Started

1. **Clone the repository**

```bash
git clone https://github.com/juliusmarkwei/azubi-commerce.git
cd azubi-commerce
```

2. **Install dependencies**

```bash
pnpm install
```

3. **Start the development server**

```bash
pnpm dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

4. **Build for production**

```bash
pnpm build
pnpm start
```

## 📁 Project Structure

```text
azubi-commerce/
├── public/ # Static files
├── src/
│ ├── app/ # App router
│ ├── components/ # Reusable components
│ ├── lib/ # Utility functions
│ └── styles/ # Global styles
├── .eslintrc.json # ESLint configuration
├── .gitignore
├── next.config.js # Next.js configuration
├── package.json # Project dependencies and scripts
├── pnpm-lock.yaml # pnpm lock file
├── postcss.config.js # PostCSS configuration
├── README.md # This file
└── tailwind.config.js # Tailwind CSS configuration
```

## 🤝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

See [CONTRIBUTING.md](CONTRIBUTE.md) for more information on how to get started.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## 📄 License

Distributed under the MIT License. See `LICENSE` for more information.

## 📧 Contact

Julius Markwei - [@juliusmarkwei](https://twitter.com/juliusmarkwei)

Project Link: [https://github.com/juliusmarkwei/azubi-commerce](https://github.com/juliusmarkwei/azubi-commerce)

## 🙏 Acknowledgments

- [Next.js Documentation](https://nextjs.org/docs)
- [React Documentation](https://reactjs.org/)
- [Tailwind CSS Documentation](https://tailwindcss.com/docs)
- [pnpm Documentation](https://pnpm.io/)