Skip to content

Commit 08d57fb

Browse files
committed
docs: Update all READMEs with project-specific content, features, and pnpm setup, and correct contributing guide URL.
1 parent 5887247 commit 08d57fb

4 files changed

Lines changed: 49 additions & 107 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Thank you for your interest in contributing to DevCard! This guide will help you
1515

1616
```bash
1717
# 1. Fork and clone the repo
18-
git clone https://github.com/<your-username>/devcard.git
18+
git clone https://github.com/Dev-Card/DevCard.git
1919
cd devcard
2020

2121
# 2. Install dependencies

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
<h1 align="center">DevCard</h1>
33
<p align="center"><strong>One Tap. Every Profile. Every Platform.</strong></p>
44
<p align="center">Open Source Developer Profile Exchange Platform</p>
5+
<p align="center">
6+
<a href="https://github.com/Dev-Card/DevCard">
7+
<img src="https://img.shields.io/badge/GitHub-Dev--Card%2FDevCard-blue?logo=github&style=flat-square" alt="GitHub Repo" />
8+
</a>
9+
</p>
510
</p>
611

712
<p align="center">
@@ -33,6 +38,8 @@ Each exchange is manual, error-prone, and slow. DevCard fixes this.
3338
- 🔗 **Universal Profile Aggregation** — GitHub, LinkedIn, Twitter/X, GitLab, Devfolio, and 10+ more platforms
3439
- 📱 **QR Code Sharing** — Show your QR, they scan, done
3540
-**One-Screen Multi-Platform Connect** — Follow on GitHub, Connect on LinkedIn, all from one card
41+
- 📈 **Advanced Analytics** — Track who viewed your card, when, and from where (Web, QR, App)
42+
- 🔌 **Per-Platform OAuth Integrations** — Securely connect accounts for "Silent Follows"
3643
- 🎯 **Context Cards** — Different cards for different situations (Professional, Hackathon, Community)
3744
- 🌐 **Web Backup** — Receivers don't need the app — works in any browser
3845
- 🔒 **Privacy-First** — No tracking, no data selling, your data stays yours

apps/mobile/README.md

Lines changed: 30 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,51 @@
1-
This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli).
1+
# DevCard Mobile
22

3-
# Getting Started
3+
The mobile application for DevCard, built with bare **React Native** and **React Navigation**.
44

5-
> **Note**: Make sure you have completed the [Set Up Your Environment](https://reactnative.dev/docs/set-up-your-environment) guide before proceeding.
5+
This app provides:
6+
- Profile and context card management
7+
- Per-Platform OAuth Connections for silent API follows
8+
- Advanced analytics for tracking profile views
9+
- The Hybrid Follow Engine (API, WebView, Link)
610

7-
## Step 1: Start Metro
11+
## Getting Started
812

9-
First, you will need to run **Metro**, the JavaScript build tool for React Native.
13+
> **Note**: Make sure you have completed the [React Native Environment Setup](https://reactnative.dev/docs/environment-setup) guide before proceeding.
1014
11-
To start the Metro dev server, run the following command from the root of your React Native project:
15+
### Install Dependencies
1216

13-
```sh
14-
# Using npm
15-
npm start
16-
17-
# OR using Yarn
18-
yarn start
17+
```bash
18+
pnpm install
1919
```
2020

21-
## Step 2: Build and run your app
22-
23-
With Metro running, open a new terminal window/pane from the root of your React Native project, and use one of the following commands to build and run your Android or iOS app:
24-
25-
### Android
21+
### Start Metro Bundler
2622

27-
```sh
28-
# Using npm
29-
npm run android
23+
First, start Metro, the JavaScript bundler:
3024

31-
# OR using Yarn
32-
yarn android
25+
```bash
26+
pnpm start
3327
```
3428

35-
### iOS
29+
### Run on Android
3630

37-
For iOS, remember to install CocoaPods dependencies (this only needs to be run on first clone or after updating native deps).
31+
In a new terminal:
3832

39-
The first time you create a new project, run the Ruby bundler to install CocoaPods itself:
40-
41-
```sh
42-
bundle install
33+
```bash
34+
pnpm android
4335
```
4436

45-
Then, and every time you update your native dependencies, run:
46-
47-
```sh
48-
bundle exec pod install
49-
```
37+
### Run on iOS
5038

51-
For more information, please visit [CocoaPods Getting Started guide](https://guides.cocoapods.org/using/getting-started.html).
39+
For iOS, you must install CocoaPods dependencies first (Mac only):
5240

53-
```sh
54-
# Using npm
55-
npm run ios
56-
57-
# OR using Yarn
58-
yarn ios
41+
```bash
42+
cd ios && pod install && cd ..
43+
pnpm ios
5944
```
6045

61-
If everything is set up correctly, you should see your new app running in the Android Emulator, iOS Simulator, or your connected device.
62-
63-
This is one way to run your app — you can also build it directly from Android Studio or Xcode.
64-
65-
## Step 3: Modify your app
66-
67-
Now that you have successfully run the app, let's make changes!
68-
69-
Open `App.tsx` in your text editor of choice and make some changes. When you save, your app will automatically update and reflect these changes — this is powered by [Fast Refresh](https://reactnative.dev/docs/fast-refresh).
70-
71-
When you want to forcefully reload, for example to reset the state of your app, you can perform a full reload:
72-
73-
- **Android**: Press the <kbd>R</kbd> key twice or select **"Reload"** from the **Dev Menu**, accessed via <kbd>Ctrl</kbd> + <kbd>M</kbd> (Windows/Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (macOS).
74-
- **iOS**: Press <kbd>R</kbd> in iOS Simulator.
75-
76-
## Congratulations! :tada:
77-
78-
You've successfully run and modified your React Native App. :partying_face:
79-
80-
### Now what?
81-
82-
- If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps).
83-
- If you're curious to learn more about React Native, check out the [docs](https://reactnative.dev/docs/getting-started).
84-
85-
# Troubleshooting
86-
87-
If you're having issues getting the above steps to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page.
88-
89-
# Learn More
90-
91-
To learn more about React Native, take a look at the following resources:
46+
## Architecture
9247

93-
- [React Native Website](https://reactnative.dev) - learn more about React Native.
94-
- [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment.
95-
- [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**.
96-
- [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts.
97-
- [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native.
48+
- **Screens**: Located in `src/screens`
49+
- **Navigation**: Managed via `src/navigation/MainTabs.tsx`
50+
- **Context API**: Handles global authentication and token management
51+
- **Theme**: Tokens are strictly defined in `src/theme/tokens.ts`

apps/web/README.md

Lines changed: 11 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,23 @@
1-
# sv
1+
# DevCard Web
22

3-
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
3+
The web backup frontend for DevCard, built with [SvelteKit](https://kit.svelte.dev/).
44

5-
## Creating a project
6-
7-
If you're seeing this, you've probably already done this step. Congrats!
8-
9-
```sh
10-
# create a new project
11-
npx sv create my-app
12-
```
13-
14-
To recreate this project with the same configuration:
15-
16-
```sh
17-
# recreate this project
18-
npx sv@0.12.6 create --template minimal --types ts --no-install apps/web
19-
```
5+
This app provides:
6+
- The landing page for DevCard
7+
- Public, browser-accessible profiles with view analytics
8+
- Cross-platform analytics source tracking
209

2110
## Developing
2211

23-
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
24-
25-
```sh
26-
npm run dev
27-
28-
# or start the server and open the app in a new browser tab
29-
npm run dev -- --open
12+
```bash
13+
pnpm install
14+
pnpm dev
3015
```
3116

3217
## Building
3318

3419
To create a production version of your app:
3520

36-
```sh
37-
npm run build
21+
```bash
22+
pnpm build
3823
```
39-
40-
You can preview the production build with `npm run preview`.
41-
42-
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.

0 commit comments

Comments
 (0)