Skip to content

Commit 76a4777

Browse files
milooyraon0211
authored andcommitted
docs: Initialize amplitude, update readme to English (#16)
* fix: remove unnessesory license text * feat: update readme to en * feat: initialize amplitude
1 parent 2c886e3 commit 76a4777

File tree

7 files changed

+284
-23
lines changed

7 files changed

+284
-23
lines changed

.env.example

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
VITE_AMPLITUDE_API_KEY=YOUR_AMPLITUDE_API_KEY

.pnp.cjs

Lines changed: 137 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.vitepress/theme/index.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
import Layout from './Layout.vue'
1+
import Layout from "./Layout.vue";
2+
import * as amplitude from "@amplitude/analytics-browser";
23

34
export default {
45
Layout,
5-
}
6+
async enhanceApp() {
7+
if (typeof window !== 'undefined') {
8+
const amplitudeApiKey = (import.meta as any).env.VITE_AMPLITUDE_API_KEY;
9+
amplitude.init(amplitudeApiKey, { autocapture: true });
10+
}
11+
}
12+
};

LICENSE.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
SOFTWARE.
22-
23-
---
24-
25-
Some of the test code in this software comes from the lodash library (https://github.com/lodash/lodash).
26-
27-
The copyright for this imported test code from lodash is owned by the JS Foundation and other contributors <https://js.foundation/>.

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
![Frontend Fundamentals](./public/images/ff-meta.png)
22

33
# Frontend Fundamentals
4-
> 변경하기 쉬운 프론트엔드 코드를 위한 지침서
4+
> Guidelines for easily modifiable frontend code
55
6-
Frontend Fundamentals(FF)는 좋은 프론트엔드 코드의 기준을 제공해요. 프론트엔드 개발자로서 코드 품질을 높이고자 할 때 방향을 찾는 나침반처럼 활용해 보세요.
7-
좋은 코드에 대한 4개 원칙과 함께, 구체적인 예시 및 해결 방안을 제시해요.
8-
https://frontend-fundamentals.com
6+
**Frontend Fundamentals (FF)** provides standards for writing great frontend code. Think of it as a compass to help you navigate towards better code quality as a frontend developer.
7+
It introduces four core principles of good code, along with practical examples and solutions.
8+
https://frontend-fundamentals.com/en/
99

10-
## 이럴 때 활용해 보세요
11-
- 🦨 코드에 대해서 고민되는데 논리적으로 설명하기 어려운 개발자
12-
- 👀 나쁜 코드를 빠르게 감지하고 개선하는 방법을 공부하고 싶은 개발자
13-
- 🤓 코드 리뷰 등에서 누가 전달해준 링크를 타고 들어와 "내 코드가 이랬구나"를 객관적 시각으로 인지하게 될 개발자
14-
- 👥 팀과 함께 공통의 코딩 스타일과 코드 품질의 기준을 세워보고 싶은 개발자
10+
## When to Use
11+
- 🦨 When you're unsure about your code but find it hard to explain the issues logically
12+
- 👀 When you want to learn how to quickly identify and fix bad code
13+
- 🤓 When you find yourself exploring a shared link during a code review and realize, "This is exactly what my code looks like," from an objective perspective
14+
- 👥 When your team wants to establish a shared coding style and standards for code quality
1515

1616
## Contributing
1717

18-
Frontend Fundamentals(FF)는 커뮤니티와 함께 좋은 코드의 기준을 만들어 가고 있어요.
18+
**Frontend Fundamentals (FF)** is a community-driven project to establish standards for writing good code.
1919

20-
고민되는 코드가 있다면 깃허브 디스커션에 글을 올려 보세요.
21-
내 코드에 대해서 커뮤니티에서 다각도로 리뷰를 받을 수 있고, 좋은 코드의 기준에 대해 커뮤니티와 함께 고민할 수 있어요.
22-
많은 공감을 받은 사례는 직접 Frontend Fundamentals 문서에 올릴 수 있어요. 기여 방법은 추후 공개될 예정이에요.
20+
If you have a piece of code you're unsure about, post it on the GitHub Discussions page.
21+
The community can provide diverse reviews of your code, helping you and others think critically about what makes good code.
22+
Highly supported cases may even make it into the Frontend Fundamentals documentation. Contribution guidelines will be announced soon.
2323

24-
- [깃허브 디스커션에 글 올리기](https://github.com/toss/frontend-fundamentals/discussions)
24+
- [Post on GitHub Discussions](https://github.com/toss/frontend-fundamentals/discussions)
2525

2626
## License
2727

@@ -32,4 +32,4 @@ MIT © Viva Republica, Inc. See [LICENSE](./LICENSE.md) for details.
3232
<source media="(prefers-color-scheme: dark)" srcset="https://static.toss.im/logos/png/4x/logo-toss-reverse.png">
3333
<img alt="Toss" src="https://static.toss.im/logos/png/4x/logo-toss.png" width="100">
3434
</picture>
35-
</a>
35+
</a>

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"docs:preview": "vitepress preview"
1111
},
1212
"dependencies": {
13+
"@amplitude/analytics-browser": "^2.11.11",
1314
"markdown-it-footnote": "^4.0.0",
1415
"typescript": "^5.6.3",
1516
"vitepress": "^1.4.1"

0 commit comments

Comments
 (0)