vikashpr / a

Yasser's Website

🌏 anaxes.xyz

My personal site created with HTML & TailwindCSS, utilising Lanyard, GitHub and Twitter API.

📚 Credits

This personal website is heavily inspired/built off of Audun's Personal Website.

🔗 Website: Audun.gg
🔗 GitHub: Audn
🔗 Twitter: tweetaudun

*Note: Audun recently updated their personal website and github repo. My personal website is built off of a previous version of their website. This repository is in no way "mine". I have just added my personality to Audun's original personal website.

🚀 Getting Started

To start off, please clone the repository:

git clone https://github.com/DiscordAnaxes/Anaxes.xyz

Next, change directory:

cd Anaxes.xyz

As this website uses TypeScript, you will need to install it:

npm install -g typescript

Then, open the directory (This step is for Visual Studio Code. Please refer to your preferred IDE/Text Editor on how to open folders/directories.):

code .

🏷️ Lanyard, 🐈 GitHub API & 🐤 Twitter API

Firstly, you want to change the API endpoints in /assets/ts/lanyard.ts, /assets/ts/github.ts, & /assets/js/twitter.ts.

In those files please change the ending of the API endpoints:

Lanyard.js file:

https://api.lanyard.rest/v1/users/<your discord id>

Github.js file:

https://api.github.com/users/<your github username>

Twitter.js file:

Unfortunately the endpoint for the Twitter API is custom and only retrieves my Twitter account data. You'll have to use your own system on getting Twitter data.

*Note: To use Lanyard API you must join their Discord Server & to compile TypeScript to JavaScript: Run tsc

🔍 Deploy on Netlify

The easiest way to deploy a website for free, is to use a provider called Netlify.

Check out the Netlify deployment documentation for more details.

👋 Conclusion

Thank you for taking your time to read this README. It would support Audun & Me greatly, if you link our respective websites in the footer area of the website (or anywhere that suits you).