Skip to content

mrevay/personal-webpage

Repository files navigation

Source code for my personal webpage.

Features

  • ⚡️ Next.js 12
  • ⚛️ React 17
  • ⛑ TypeScript
  • 📏 ESLint — Find and fix problems in your code
  • 💖 Prettier — Code Formatter for consistent style
  • 🐶 Husky — For running scripts before committing
  • 📄 Commitizen — To define a standard way of committing rules
  • 🚓 Commitlint — Make sure your commit messages follow the convention
  • 🖌 Renovate — Keep your dependencies up to date
  • 🚫 lint-staged — To run ESLint and Prettier against staged Git files
  • 👷 PR Workflow — Run Type Check & Linters on all Pull Requests
  • ⚙️ EditorConfig - Maintain consistent coding styles across editors and IDEs
  • 🗂 Path Mapping — Import components or images using the @ prefix

Development

To start the project locally, run:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Documentation

Requirements

  • Node.js >= 12.22.0
  • Yarn 1 (Classic)

Directory Structure

  • .github — GitHub configuration including the CI workflow.
  • .husky — Husky configuration and hooks.
  • public — Static assets such as robots.txt, images, and favicon.
  • src — Application source code, including pages, components, styles.

Scripts

  • yarn dev — Starts the application in development mode at http://localhost:3000.
  • yarn build — Creates an optimized production build of your application.
  • yarn start — Starts the application in production mode.
  • yarn type-check — Validate code using TypeScript compiler.
  • yarn lint — Runs ESLint for all files in the src directory.
  • yarn format — Runs Prettier for all files in the src directory.
  • yarn commit — Run commitizen. Alternative to git commit.

License

This project is licensed under the MIT License - see the LICENSE.md file for more information.