Next.js Portfolio for Chris Stevens

This is a portfolio website designed to showcase my work history and ability to prospective clients. Highlights include a Resume Assistant using ChatGPT and a Discord webhook used to track visits.

Table of Contents

• Prerequisites
• Getting Started
  • Installation
  • Running in Development Mode
  • Building for Production
• Project Structure
• Contributing
• License

---

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or higher recommended)
• npm or Yarn (npm is included with Node.js)
• Git (for cloning the repository)

---

Getting Started

Follow these steps to set up the project locally.

Installation

1. Clone the repository:

   git clone https://github.com/your-username/your-repo-name.git

2. Navigate to the project directory:

   cd your-repo-name

3. Install dependencies:

   Using npm:

   npm install

   Or using Yarn:

   yarn install

Running in Development Mode

To start the development server:

npm run dev

or

yarn dev

The development server will start at http://localhost:3000. Open this URL in your browser to view the app. The page will automatically reload if you make changes to the code.

Building for Production

To build the project for production:

npm run build

or

yarn build

This will create an optimized production build in the .next folder.

To start the production server:

npm start

or

yarn start

The app will be served at http://localhost:3000.

Linting

This project uses ESLint with the eslint-plugin-jsx-a11y plugin to ensure accessibility standards are met. The following commands are available:

# Run the linter
npm run lint

# Automatically fix linting issues where possible
npm run lint:fix

Linting is automatically run before each production build. The configuration includes strict accessibility rules to maintain WCAG compliance.

---

Project Structure

Here's an overview of the key files and folders in the project:

cjstevens78.github.io/
├── .next/                  # Build output (generated during build) - you wont see this in git
├── public/                 # Static assets (e.g., images, fonts)
├── src/
│   ├── pages/              # Next.js pages (routes)
│   ├── components/         # Reusable React components
│   ├── styles/             # CSS or SCSS files
│   └── utils/              # Utility functions
├── .gitignore              # Files and folders to ignore in Git
├── next.config.js          # Next.js configuration
├── package.json            # Project dependencies and scripts
└── README.md               # This file

---

Contributing

Contributions are welcome! If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Commit your changes.
4. Push your branch and open a pull request.

Please ensure your code follows the project's coding standards and includes appropriate tests.

---

License

This project is licensed under the MIT License. Feel free to use, modify, and distribute it as needed.

---

Replace placeholders like your-username, your-repo-name, and Project Name with your actual details. You can also customize the project structure and other sections to better fit your specific project. This format is clean, professional, and widely recognized in open-source projects.