Skip to content

furre-dev/furre-nextjs-portfolio

Repository files navigation

Overview

Welcome to the Furre Portfolio project! This Next.js 13 application is built with TypeScript, utilizes app routes. It features OpenAI chatbot prompt engineering, semantic HTML, SEO optimization, and performance optimization to ensure good Core Web Vitals and Lighthouse scores.

🚀 Getting Started

Follow these steps to set up the Furre Portfolio project locally:

Prerequisites

Ensure that you have the following software installed on your system:

Installation

  1. Clone the repository:
git clone https://github.com/furre-dev/furre-nextjs-portfolio.git
  1. Change to the project directory:
cd furre-nextjs-portfolio
  1. Install the necessary dependencies:
npm install
  1. Create a .env file based on the provided .env.example file.

  2. Start the development server:

npm run dev

This will start the Next.js development server at http://localhost:3000.

✅ Linting and Type Checking

This project employs lint-staged and simple-git-hooks to enforce code formatting and type checking before committing or pushing to the repository.

*.{js,jsx,ts,tsx} files are automatically formatted with Rome when you commit your changes. Also, npm run type-check is executed before pushing to the repository.

📜 Available Scripts

In the project directory, you can run the following commands:

Development Mode

npm run dev

Runs the app in development mode.

Production Mode

npm start

Starts the app in production mode.

Linting

npm run lint

Lints the project files.

Type Checking

npm run type-check

Checks the project's TypeScript types.


Thank you for checking out the Furre Portfolio project!