xfox111.net website

This repository contains the source code for my personal website, built using Next.js. The website serves as a portfolio, showcasing my projects skills. Feel free to use this code as a base or a template for your own personal website.

Features

• Responsive Design: Optimized for desktop and mobile devices.
• Dark Mode: Automatic light and dark themes based on your browser preferences.
• Accessibility: Full keyboard navigation and screen reader support.
• Customizable: You can use this website as a template for your own personal website.
• Docker and Dev Containers: Containerized development and deployment.

Technologies

• Next.js framework for server-side rendering and static site generation.
• React library for building user interfaces.
• SASS preprocessor.
• TypeScript.

Development

Prerequisites

For development you can use Dev Containers or GitHub Codespaces. Otherwise you will need to install following tools:

• Node.js
• Yarn
• Docker

Building and debugging

Here're some commonly used commands:

yarn install		# Install dependencies
yarn dev			# Start the development server at http://localhost:3000
yarn lint			# Lint the project with ESLint
yarn build			# Build the project for production

To build a Docker image, run:

docker build -t <tag_name> .

Tip

If you use VS Code, you can also use pre-defined tasks for building and debugging.

Customization

You can customize the website by modifying its components and styles.

Here's a general checklist of things you need to change:

Environment

• package.json (URLs and author information)
• .env.* (required for website to function)

Assets

• /app/favicon.ico
• /app/icon.svg
• /app/apple-icon.png
• /app/opengraph-image.png
• /app/opengraph-image.alt.txt
• /app/_assets

Content

• app/_data (text information and some page elements)
• (optional) app/attribution/page.tsx (license and attribution information)
• (optional) app/theme.[light|dark].scss (color schemes)
• (optional) Files marked with [SPECIAL] tag (these contain custom elements, which may be not suitable for your needs)

Important

Some of the files are copyrighted and should not be used without permission. See COPYING.

Contributing

Contributions are welcome! If you have suggestions or improvements, feel free to open an issue or submit a pull request.

Note

Please make sure to follow the contributing guidelines

License

This repository is partially licensed under MIT license.

Important

Some content of this repository is exempt from MIT license coverage and is subject to general copyright law. See COPYING for more information.

---

©2024 Eugene Fox. Some rights reserved