Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hellofaizan/xprofile

𝕏 Profile - Twitter Profile Card | List your Twitter Profile
https://github.com/hellofaizan/xprofile

collaborate github good-first-issue good-first-project good-for-beginners hacktoberfest json learn mongodb namecheap open-source profilecard student-vscode twitter

Last synced: 5 days ago
JSON representation

𝕏 Profile - Twitter Profile Card | List your Twitter Profile

Host: GitHub
URL: https://github.com/hellofaizan/xprofile
Owner: hellofaizan
License: mit
Created: 2023-07-29T10:32:17.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-06-08T11:30:05.000Z (5 months ago)
Last Synced: 2024-10-04T11:58:08.366Z (about 1 month ago)
Topics: collaborate, github, good-first-issue, good-first-project, good-for-beginners, hacktoberfest, json, learn, mongodb, namecheap, open-source, profilecard, student-vscode, twitter
Language: JavaScript
Homepage: https://x.hellofaizan.tech
Size: 889 KB
Stars: 61
Watchers: 2
Forks: 68
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

# 𝕏 Profile Card

> [!NOTE]
> Working on version 2 with a lot of features. [Have a look by clicking here](https://github.com/Youth-Icon/xprofile)
> also [join Discord](https://discord.gg/vUHMxPvege) to discuss upcoming features

A website to list your Twitter ( 𝕏 ) and Github profile to the world

![image](https://github.com/hellofaizan/xprofile/assets/84437051/5b463c7d-4488-4743-8e56-f0cf31c6ba3d)

## Languages/Tools

## 👩🏽‍💻 Demo

Check out the website: [𝕏 Profiles](https://x.hellofaizan.me)

## 👇🏽 File Format
```json
,{
"username": "hellofaizaan",
"name": "Hello Faizan",
"github": "hellofaizan",
"banner_color": "#ff2500",
"about": "I am a full stack developer and a competitive programmer. I love Chess♟️ also https://hellofaizan.me/"
}
```

| Key | Value |
| ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| username | This value should be your Twitter (𝕏) username.|
| name | This value should be your real name. |
| github | The value should be your Github username |
| banner_color | The value should contain any hex code for background just like Twitter eg: #fff, #000 |
| about | Short simple `max 2 lines` about yourself, You can also include links which are clickable |

## 🛠️ Installation Steps

### 🔥 Add your profile using

1. Fork the project:

- [Fork](https://github.com/hellofaizan/xprofile/fork) the project. Click on the icon in the top right to get started.

2. Create a New Branch:

- On your new repository's page, click the gray `main` button in the upper left to reveal a dropdown menu.
- Enter the name of your new branch in the text box. (Branch names usually make a reference to what is being changed. Example: `profileAdd`).
- Click on `Create branch ` 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 `xprofile` `main` branch.

3. Navigate to file:

- Navigate to the `data/users.json` file.

4. Edit:

- On the top right of the JSON file, click on the pencil icon to edit the file by adding your image, name and username.
- You can add JSON object wherever you want in the file, it will automatically arrange according to alphabetical order.
- After editing the JSON file, add a commit message and click on the green button saying "Commit Changes". Make sure you have selected the branch you have created.

5. Raise a Pull Request:

- And finally, create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)!
- Great job! You did it!
- Remember to PR in ```addProfile branch of repository```

## 🚀 Running locally
To run locally, just `cd` into the project and run the following commands to run node modules and serve the website locally.
```bash
yarn
```

```bash
yarn run dev
```

## 💪🏽 Contributors

Thank you all so much for spending your time to improve 𝕏 Profile.

## Repository Activity

![Alt](https://repobeats.axiom.co/api/embed/3c905c2b26fc447eb080acba085a899468acd7e3.svg "Repobeats analytics image")

## Star History

# Join Discord 💻

## Drop a ⭐ if you like this project