Skip to content

Latest commit

 

History

History
179 lines (136 loc) · 6.25 KB

README.md

File metadata and controls

179 lines (136 loc) · 6.25 KB

🔗 JRLinks

Made with love License


If you want to read this readme in Spanish

📜 About

I have created this page with the intention of having all my links in one place. You can find me on all my platforms here. 💜

(Go Back To Top 🔝)

👀 Preview

In a PC (1920x1080)

In a iPhone SE (375x667)

project-screenshot

(Go Back To Top 🔝)

💬 Features

  • Links: Links to various Social Media Platforms, Messaging Platforms and Games/Educational Platforms.
  • Favicon Support: Support for a wide range of favicon sizes has been added, ensuring that the site’s icon displays correctly on all devices and platforms.
  • Open Graph and Twitter Tags: Open Graph and Twitter meta tags have been included, which optimize the preview of the website on social platforms like Facebook and Twitter.
  • Responsive Design: The website has been designed to be responsive, which means it will look good on devices of all sizes.
  • Language Localization: A script for changing the language has been added, making the site more accessible to users who speak different languages.

(Go Back To Top 🔝)

🧰 Stack

  • Vite - It’s a fast and flexible tool for building and testing JavaScript applications.
  • HTML - It’s the standard markup language for web pages.
  • PostCSS - It allows you to use modern CSS features and plugins to write and process CSS with JavaScript.
  • JavaScript - It’s the world’s most popular programming language.
  • ESLint - It’s an open-source tool that helps you find and fix problems with your JavaScript code.
  • Stylelint - It’s a tool that checks your CSS code for syntax, features, and conventions

(Go Back To Top 🔝)

🚀 Getting Starter

  1. Fork or clone this repository
git clone git@github.com:joserafael0160/JRLinks.git
  1. Install the dependencies:
  • I used bun to install and manage the dependencies.
# Install bun for MacOS, WSL & Linux:
curl -fsSL https://bun.sh/install | bash

# Install bun for Windows:
powershell -c "iwr bun.sh/install.ps1|iex"

# Install with bun:
bun install
  • or you can use pnpm:
# Install pnpm globally if you don't have it:
npm install -g pnpm

# Install dependencies:
pnpm install
  1. Run the development server:
# Run with bun:
bun run dev

# Run with pnpm:
pnpm run dev

(Go Back To Top 🔝)

🧞 Commands

Command Action
⚙️ dev Starts local dev server.
⚙️ build Build your production site to ./dist/.
⚙️ preview Preview your build locally, before deploying.
⚙️ deploy Deploy your website to github pages.

(Go Back To Top 🔝)

🤝 Contributions

Contributions are always welcome! Whether you’re reporting bugs, requesting new features, or improving existing functionalities, your help is greatly appreciated.

If you have any suggestions that could improve the project, please make a fork of the repository and create a pull request. You can also simply open an issue with the “enhancement” label.

Here is a quick guide:

  1. Make a fork of the Project
  2. Clone your fork (git clone <URL of the fork>)
  3. Add the original repository as remote (git remote add upstream <URL of the original repository>)
  4. Create your Feature Branch (git switch -c feature/NewFeature)
  5. Make your Changes (git commit -m 'Add: some NewFeature')
  6. Push to the Branch (git push origin feature/NewFeature)
  7. Open a pull request

(Go Back To Top 🔝)

🔑 License

MIT

(Go Back To Top 🔝)

🙏 Support

Don't forget to leave a star ⭐️

(Go Back To Top 🔝)



✌️

A project created by @joserafael0160