Skip to content

Commit e06a5f4

Browse files
authored
Update README.md
1 parent bf18d78 commit e06a5f4

File tree

1 file changed

+6
-62
lines changed

1 file changed

+6
-62
lines changed

README.md

Lines changed: 6 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ A platform to create your LeetCode statistics and showcase your LeetCode profile
1010
## Languages/Tools
1111

1212
<a href="">
13-
<img src="https://skillicons.dev/icons?i=tailwindcss,js,react,firebase,nodejs,vercel" />
13+
<img src="https://skillicons.dev/icons?i=tailwindcss,js,react,mongodb,nodejs,vercel,typescript" />
1414
</a>
1515

1616
## 👩🏽‍💻 Demo
17-
Check out the website: [𝙻𝚎𝚎𝚝𝙲𝚘𝚍𝚎 𝙿𝚛𝚘𝚏𝚒𝚕𝚎𝚜](https://leetcode-profiles.vercel.app/)
17+
Check out the website: [𝙻𝚎𝚎𝚝𝙲𝚘𝚍𝚎 𝙿𝚛𝚘𝚏𝚒𝚕𝚎𝚜](https://leetcode-profiles-delta.vercel.app/)
1818

1919

2020
## 🛠️ Installation Steps
@@ -27,80 +27,24 @@ Check out the website: [𝙻𝚎𝚎𝚝𝙲𝚘𝚍𝚎 𝙿𝚛𝚘𝚏𝚒
2727
- Enter the name of your new branch in the text box. (Branch names usually make a reference to what is being changed. Example: `FixMargin`).
2828
- Click on `Create branch <new branch name>` and this will automatically take you to your new branch. You can make edits on the main branch, but this may cause issues down the line. Best practice is to create a new branch for each separate issue you work on. That way, your `main` branch remains in sync with `leetcode-profiles` `main` branch.
2929

30-
### 3. Setup Firebase:
31-
- Below are the steps to setup firebase.
32-
33-
### 4. Edit:
30+
### 3. Edit:
3431
- Do the desired changes, you want.
3532

36-
### 5. Raise a Pull Request:
33+
### 4. Raise a Pull Request:
3734
- And finally, create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)!
3835
- Great job!
3936

4037

41-
## Setting up Firebase
42-
43-
1. **Firebase Account Setup:**
44-
- Sign up for a free Firebase account at [Firebase Console](https://console.firebase.google.com/).
45-
46-
2. **Create a Firebase Project:**
47-
- Create a new Firebase project via the Firebase Console.
48-
49-
3. **Add Firebase to your web app:**
50-
- Set up the firebase for your webapp and then Add Firebase SDK.
51-
52-
4. **Create Database(firestore Database)**
53-
54-
5. **Create a collection with the file format below (not necessary):**
55-
56-
57-
### 👇🏽 File Format
58-
- `userName(String) = druv_kotwani`
59-
- `website(Map) = {link: https://dhruvkotwani.me/, text: dhruvkotwani.me}`
60-
- `badgeImg(String) = https://leetcode.com/static/images/badges/dcc-2023-10.png`
61-
- `mediumBeats(String) = 85.6%`
62-
- `easyBeats(String) = 96.9%`
63-
- `totalQuestions(Number) = 2940`
64-
- `fullName(String) = Dhruv Kotwani`
65-
- `github(Map) = {link: https://github.com/druvkotwani, text: druvkotwani}`
66-
- `image(String) = https://assets.leetcode.com/users/avatars/avatar_1672478903.png`
67-
- `hardBeats(String) = 77.62`
68-
- `totalSolved(Number) = 282`
69-
- `easySolved(String) = 165`
70-
- `linkedin(Map) = {link: https://linkedin.com/in/dhruv-kotwani, text: dhruv-kotwani}`
71-
- `rank(String) = 230,203`
72-
- `easyTotal(String) = 746`
73-
- `mediumSolved(String) = 97`
74-
- `hardTotal(String) = 645`
75-
- `hardSolved(String) = 20`
76-
- `twitter(Map) = {link: https://twitter.com/druv_kotwani, text: druv_kotwani}`
77-
- `mediumTotal(String) = 1549`
78-
79-
6. **Replace the firebaseConfig inside firebase.js with your actual apiKeys, and rest of the data**
80-
7. **Add now you are good to go**
81-
8238
## 🚀 Running Frontend
8339
To run locally, just `cd` into the `client` and run the following commands to run node modules and serve the website locally.
8440
```bash
85-
npm i
41+
yarn install
8642
```
8743

8844
```bash
89-
npm run dev
45+
yarn run dev
9046
```
9147

92-
## 🚀 Running Backend(only necessary if you had made changes in the api)
93-
To run locally, just `cd` into the `server` and run the following commands to run node modules and serve the website locally.
94-
```bash
95-
npm i
96-
```
97-
98-
```bash
99-
node index.js
100-
```
101-
102-
103-
10448

10549
<hr/>
10650

0 commit comments

Comments
 (0)