Vinami🍷

A wine pairing service that helps you find the perfect wine to pair with your food.

Translation

• English
• 한국어

Table of Contents

• Getting Started

  • Prerequisites
  • Installing

• Built With

• Project Structure

• Authors

• License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js - JavaScript runtime built on Chrome's V8 JavaScript engine.
• Yarn - Dependency Management

Installing

1. Clone the repo

   git clone https://github.com/0420syj/vinami.git
   cd vinami

2. Install dependencies

   yarn

3. Start the development server

   yarn mariage dev
   yarn admin dev

4. Start the storybook

   yarn storybook

Built With

• Next.js - The web framework used in apps/mariage

• Nuxt.js - The web framework used in apps/admin

• Yarn - Dependency Management

  • Yarn Workspaces - Yarn Workspaces is a feature that allows you to setup multiple packages in such a way that you only need to run yarn install once to install all of them in a single pass.
  • Yarn Berry - Yarn 2 is a new version of Yarn that has been designed from the ground up with reliability, speed, and security in mind. It has already been used to build large production codebases at companies such as Bloomberg, Facebook, Google, and Microsoft.

• TypeScript - Typed JavaScript at Any Scale.

• Tailwind CSS - A utility-first CSS framework for rapidly building custom designs.

• Storybook - UI component explorer for frontend developers used in common/ui

• Jest - Delightful Javascript Testing Framework with a focus on simplicity

Project Structure

. # Root
├── apps
│   ├── admin # Admin app (Nuxt.js)
│   └── mariage # Front app (Next.js)
└── common
    ├── ui # UI components (Storybook)
    └── utils # Shared utils

Authors

• Wan Sim - Initial work

License

This project is licensed under the MIT License