Linklip-Client

Overview

어떻게 하면 다양한 형태의 순간적인 정보를 간편하게 저장하고 체계적으로 관리할 수 있을까?
여러분들의 효율적인 정보 관리를 위한 최고의 수단, 링클립입니다.

Developing

Built With

• React
• React Router
• Vite
• Tailwind CSS
• AWS Amplify
• PWA
• TypeScript

Prerequisites

• Install editor Visual Studio Code or WebStorm
• Install ESLint, Prettier extensions(plugins) in the editor.
  • ESLint: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
  • Prettier: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
• Turn the formatOnSave option on.
• Make sure your NodeJS and yarn versions are up to date

Setting up Dev

$ git clone https://github.com/SoftwareMaestro-LinkLip/LinkLip-Client.git
$ cd LinkLip-Client
$ yarn install

Deploying / Publishing

• Make pull request to main branch and merge it.
• Check building success in AWS Amplify.

Quick Start

Prerequisites

• Make sure your NodeJS and yarn versions are up to date

Download

• Download the latest version

or

• Clone the repository

$ git clone https://github.com/SoftwareMaestro-LinkLip/LinkLip-Client.git

Installation

$ yarn install

Basic Usage

• start server

$ yarn dev

• Navigate to http://localhost:3000

Directory Structure

linklip-client
├── public/             # static files
│   ├── icons/          # icon images for mobile
│   ├── manifest.json
│   └── sw.js
│
├── src/                # project root
│   ├── assets/         
│   │   ├── css/        # css/scss styles
│   │   └── images/     # images, icons, etc.
│   │
│   ├── hooks/          # custom hooks
│   ├── pages/          # application views
│   ├── partials/       # components
│   ├── stores/         # atoms, selectors for Recoil
│   ├── typings/        # types for typescript
│   ├── utils/          # utilities
│   ├── App.tsx
│   ├── ...
│   └── main.tsx
│
├── env
├── env.production
├── index.html
├── pakage.json
├── ...
└── yarn.lock