E-Kauppa

A NextJS Ecommerce Application

Built with the tools and technologies:

Table of Contents

• Overview
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Development
• Testing
• 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:

   git clone https://github.com/ryanzam/ecomm-kauppa.git

2. Navigate to the project directory:

   cd ecomm-kauppa

3. Install dependencies:

   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:

   npm run migrate

6. Start the development server:

   npm run dev

Usage

After starting the server, access the application at http://localhost:3000. Refer to the 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:

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 for more details.