Repository files navigation

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

Check out the website:𝕏 Profiles

    ,{"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/"    }

1. Fork the project:

• 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 graymain 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 onCreate 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, yourmain branch remains in sync withxprofilemain branch.

3. Navigate to file:

• Navigate to thedata/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 aPull Request!
• Great job! You did it!
• Remember to PR inaddProfile branch of repository

To run locally, justcd into the project and run the following commands to run node modules and serve the website locally.

yarn

yarn run dev

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