README.md

Personal Website

Welcome to my personal website project! This repository contains the code for my personal website, where I showcase my portfolio, projects, and other information about myself.

The website is built using Next.js as the build tool, Shadcn UI as the JavaScript library for building user interfaces, Tailwind CSS for styling, and TypeScript for type checking and improved developer experience.

The website is hosted on https://badend.is-a.dev/, and you can visit it to see the live version.

Table of Contents

• Personal Website
  • Table of Contents
  • Prerequisites
  • Technologies Used
  • Usage
    • Development
    • Production
  • Project Structure
  • Contributing
  • License
  • Contact

Prerequisites

• Node.js (LTS version recommended)
• npm or pnpm (Or other package manager of your choice)
• Git (Optional, but recommended)

Technologies Used

• Next.js — The React framework for production
• shadcn/ui — Beautiful design components for modern web applications
• Tailwind CSS — A utility-first CSS framework for rapid UI development
• TypeScript — A typed superset of JavaScript that compiles to plain JavaScript

Usage

Development

To work on the project locally, ensure you have Node.js installed on your machine.

• Clone the repository:

git clone https://github.com/BadEnd777/Personal-Website.git

Alternatively, you can download the ZIP file and extract it to a directory of your choice.

• Navigate to the project directory:

cd Personal-Website # or open the directory in your file explorer

• Install dependencies:

npm install  # or `pnpm install` if you prefer pnpm

• Start the development server:

npm run dev  # or `pnpm run dev` if you prefer pnpm

• Open your browser and visit http://localhost:3000 to view the website locally.

Production

To build the project for production deployment, run:

npm run build  # or `pnpm run build` if you prefer pnpm

The optimized production-ready assets will be generated in the dist directory. You can then host these files on a web server to make the website accessible online.

Project Structure

The project structure is as follows:

• public: Stores static assets like images, and icons.
• src: Contains the source files for the website.
  • app: Contains the Next.js pages for the website.
  • components: Contains the React components used in the website.
  • data: Contains the data files for the website.
  • lib: Contains the utility functions and helper modules for the website.
  • styles: Contains the Tailwind CSS styles for the website.
• components.json: Shadcn-solid components configuration.
• postcss.config.js: PostCSS configuration.
• tailwind.config.ts: Tailwind CSS configuration.
• tsconfig.json: TypeScript configuration.

Contributing

Contributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or create a pull request.

License

This project is licensed under the MIT License.

Contact

Feel free to contact me at [email protected] for any questions or inquiries.

Happy coding! 🚀

---