Skip to content

Commit a358a34

Browse files
authored
Merge pull request #84 from sohnjunior/feature/readme
Readme 문서를 추가합니다.
2 parents a7c259f + 292a615 commit a358a34

1 file changed

Lines changed: 53 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# 🎨 editty
2+
3+
**Lightweight sketch web-app with vanilla typescript**
4+
5+
Simple web app inspired by FigJam.
6+
With PWA, It can be installed and used offline.
7+
8+
Developed using Native Web APIs such as Web component, Canvas, IndexedDB, Cache & Storage API and TypeScript.
9+
10+
After drawing with the pen, uploading and editing images, you can save and manage the results as files.
11+
12+
## 🏃 Getting Started
13+
14+
### 1️⃣ Clone repository
15+
16+
```bash
17+
$ git clone https://github.com/sohnjunior/editty.git
18+
$ cd editty
19+
```
20+
21+
### 2️⃣ Install dependencies
22+
23+
```bash
24+
$ yarn install
25+
```
26+
27+
### 3️⃣ Run local dev server
28+
29+
```bash
30+
$ yarn dev
31+
```
32+
33+
## 🧪 Test
34+
35+
Perform component unit testing with Jest & Jest DOM.
36+
37+
```bash
38+
$ yarn test
39+
```
40+
41+
Use Storybook together for component-driven development in an isolated environment.
42+
43+
```bash
44+
$ yarn storybook
45+
```
46+
47+
Also, perform component visual testing with Chromatic.
48+
49+
## 🔀 CI & CD
50+
51+
Manage CI/CD with GitHub workflow and Vercel.
52+
53+
When the milestone assigned to each version are completed, a release note is created and the commit version build artifact is converted to production mode.

0 commit comments

Comments
 (0)