Skip to content

Latest commit

 

History

History
100 lines (62 loc) · 2.46 KB

README.md

File metadata and controls

100 lines (62 loc) · 2.46 KB

React + TypeScript + Vite

License: MIT

This is the portfolio website for Ji Yun Pahk, a talented brand designer. The website showcases her work, vision, and creativity.

🚀 Live Preview

The portfolio is live at: https://rriamarria.de

🛠️ Technologies Used

Frontend

  • React: For building the UI.
  • React Router DOM: For routing and navigation.
  • TypeScript: Provides static typing for JavaScript.

Styling

  • TailwindCSS: Utility-first CSS framework.
  • Tailwind Plugins: Aspect Ratio, Forms, and Typography.

Development

  • Vite: Fast build tool.
  • ESLint & Prettier: Ensures code quality and style consistency.
  • Jest & Testing Library: For unit and integration testing.

🌐 Deployment

The project is deployed using GitHub Pages. The deployment workflow uses the gh-pages branch.

🚨 Known Issues

  • The website is still a work in progress. Features and sections may be incomplete or under development.

🛠️ Features

  • React + Vite + TypeScript: A modern stack for fast and efficient development.
  • TailwindCSS: Fully responsive and styled using TailwindCSS with plugins for forms, typography, and aspect ratios.
  • GitHub Pages Deployment: Hosted and deployed via GitHub Pages.
  • React Router: Smooth navigation between pages.
  • Accessibility: Ensures good practices with eslint-plugin-jsx-a11y.

📦 Installation

To set up the project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/mariamarinescu/ji-yun.git
cd ji-yun

  2. Install dependencies:

    npm install

  3. Start the development server:

    npm run dev

  4. Build the project:

    npm run build

  5. Preview the production build:

    npm run preview

🧩 Scripts

  • npm run dev: Starts the development server.
  • npm run build: Builds the project for production.
  • npm run preview: Previews the production build.
  • npm run lint: Runs ESLint to analyze the code for issues.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

📧 Contact

For inquiries, reach out at [email protected].

Contributions

Feel free to open issues or submit pull requests if you'd like to contribute to the project.