Skip to content

Commit

Permalink
[Docs] Move README.md to Frontend
Browse files Browse the repository at this point in the history
  • Loading branch information
kms7530 committed Jul 26, 2023
1 parent 4302a7c commit 0604dc2
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 27 deletions.
27 changes: 27 additions & 0 deletions Frontend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# [프로젝트 명] - Frontend
[프로젝트 명]의 프론트엔드 프로젝트 입니다.

## 📄 간략 설명
- React와 vite로 구성된 프론트엔드 프로젝트 입니다.
- Tailwind CSS를 이용하여 디자인을 구성하였습니다.

## 🚀 사용 방법
1. 먼저 시작에 앞서, 다음의 내용의 파일을 `./env.local`에 만드십시오.
```
VITE_SUPABASE_URL=SUPABASE_URL
VITE_SUPABASE_ANON_KEY=SUPABASE_KEY
```
2. 다음의 명렬어를 이용하여 설치하십시오.
```
npm install
```
3. 다음의 명령어로 실행이 가능합니다.
```
npm run dev
```
### ☁️ 배포
1. 다음의 명령어로 프로젝트를 build 할 수 있습니다.
```
npm run build
```
2. 경로 `./dist`의 폴더에 결과물이 생성됩니다. 해당 결과물을 배포하시면 됩니다.
27 changes: 0 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +0,0 @@
# [프로젝트 명] - Frontend
[프로젝트 명]의 프론트엔드 프로젝트 입니다.

## 📄 간략 설명
- React와 vite로 구성된 프론트엔드 프로젝트 입니다.
- Tailwind CSS를 이용하여 디자인을 구성하였습니다.

## 🚀 사용 방법
1. 먼저 시작에 앞서, 다음의 내용의 파일을 `./env.local`에 만드십시오.
```
VITE_SUPABASE_URL=SUPABASE_URL
VITE_SUPABASE_ANON_KEY=SUPABASE_KEY
```
2. 다음의 명렬어를 이용하여 설치하십시오.
```
npm install
```
3. 다음의 명령어로 실행이 가능합니다.
```
npm run dev
```
### ☁️ 배포
1. 다음의 명령어로 프로젝트를 build 할 수 있습니다.
```
npm run build
```
2. 경로 `./dist`의 폴더에 결과물이 생성됩니다. 해당 결과물을 배포하시면 됩니다.

0 comments on commit 0604dc2

Please sign in to comment.