Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: updated readme #23

Merged
merged 1 commit into from
Nov 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,43 @@
# Mark 4

Look at the [nuxt 3 documentation](https://v3.nuxtjs.org) to learn more.
The 4th iteration of Radison Akerman's personal website, built on next-gen Nuxt v3 and Tailwinds

[![Nuxt Production](https://github.com/rak3rman/mark4/actions/workflows/production_deploy.yml/badge.svg)](https://github.com/rak3rman/mark4/actions/workflows/production_deploy.yml)

## Project Overview

Mark 4 is Radison Akerman's personal website and portfolio, designed to showcase my professional experience, projects, and technical writing in a sharp, modern interface. The site is built with cutting-edge web technologies to deliver a fast, responsive experience while maintaining excellent SEO and accessibility.

### Key Features

- **Modern Stack**: Built with Nuxt 3 and Tailwind CSS for optimal performance and maintainability
- **Content Management**: Uses Nuxt Content module for easy markdown-based content updates
- **Dynamic Components**: Custom Vue components for interactive sections like project showcases
- **Responsive Design**: Fully responsive layout that works seamlessly across all devices
- **SEO Optimized**: Built-in SEO optimization with meta tags and structured data
- **Fast Loading**: Leverages Nuxt's static site generation for lightning-fast page loads
- **Cloud Deployment**: Automated deployment to Cloudflare Workers for global edge delivery

### Design Philosophy

Simple. Sharp. No compromises.

- **Colors:** Primary colors are black and white, with accents in "radical" blue-gray
- **Typography:** Sans-serif font with a focus on readability and minimalism
- **Layout:** Clean, grid-based design with a focus on whitespace and content hierarchy

#### Inspiration

- [Apple web design](https://www.apple.com)
- [SpaceX Starship/Dragon mission info display design (which I worked on!), not the website :/](https://www.spacex.com)

Everything else is original!

## Nuxt 3

### Setup

Make sure to install the dependencies:

```bash
npm install
```
Expand Down Expand Up @@ -76,4 +106,4 @@ wrangler publish

### Deploy within CI/CD using GitHub Actions

Create a token according to [the wrangler action docs](https://github.com/marketplace/actions/deploy-to-cloudflare-workers-with-wrangler#authentication) and set `CF_API_TOKEN` in your repository config on GitHub.
Create a token according to [the wrangler action docs](https://github.com/marketplace/actions/deploy-to-cloudflare-workers-with-wrangler#authentication) and set `CF_API_TOKEN` in your repository config on GitHub.