https://github.com/ryanzam/ecomm-kauppa
fullstack ecommerce application built with nextjs13
https://github.com/ryanzam/ecomm-kauppa
mongodb nextjs reactjs vercel
Last synced: 8 months ago
JSON representation
fullstack ecommerce application built with nextjs13
- Host: GitHub
- URL: https://github.com/ryanzam/ecomm-kauppa
- Owner: ryanzam
- Created: 2023-09-27T14:50:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-21T07:48:24.000Z (about 1 year ago)
- Last Synced: 2025-07-28T05:33:37.230Z (11 months ago)
- Topics: mongodb, nextjs, reactjs, vercel
- Language: TypeScript
- Homepage:
- Size: 493 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
E-Kauppa
A NextJS Ecommerce Application
Built with the tools and technologies:
## Table of Contents
- [Overview](#overview)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Development](#development)
- [Testing](#testing)
- [Contributing](#contributing)
## Overview
eComm-Kauppa is a robust, scalable e-commerce platform designed to provide a seamless shopping experience. Built with modern web technologies, it offers features like product management, user authentication, and secure checkout processes.
## Getting Started
### Prerequisites
Before you begin, ensure you have the following installed:
- **Node.js**: v18.x or later
- **npm**: v9.x or later
- **PostgreSQL**: v15.x or later
- **Git**: For cloning the repository
### Installation
Follow these steps to set up the project locally:
1. **Clone the repository**:
```bash
git clone https://github.com/ryanzam/ecomm-kauppa.git
```
2. **Navigate to the project directory**:
```bash
cd ecomm-kauppa
```
3. **Install dependencies**:
```bash
npm install
```
4. **Set up environment variables**:
- Create a `.env` file in the root directory and configure it with your PostgreSQL credentials and other necessary settings (refer to `.env.example`).
5. **Initialize the database**:
```bash
npm run migrate
```
6. **Start the development server**:
```bash
npm run dev
```
## Usage
After starting the server, access the application at `http://localhost:3000`. Refer to the [wiki](https://github.com/ryanzam/ecomm-kauppa/wiki) for detailed usage instructions and API endpoints.
## Development
- **Code Style**: Follow ESLint and Prettier standards (configured in the project).
- **Build**: Run `npm run build` to create a production build.
- **Linting**: Use `npm run lint` to check code quality.
## Testing
Run tests with Jest:
```bash
npm test
```
## Contributing
We welcome contributions! Please fork the repository and submit pull requests. Ensure you adhere to the coding standards and include tests where applicable. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.