portfolio/README.md
Ryan Freeman c0db78e6b4
All checks were successful
Build And Publish / BuildAndPublish (push) Successful in 2m19s
Update README
2024-08-23 19:35:59 +01:00

1.4 KiB

Portfolio of Ryan Freeman

Portfolio

This website was built using TypeScript, React, Next.js and Tailwind CSS. It is designed to showcase my professional experience and skills, as well as provide information about me and my interests.

Project structure

  • app/ - App router.
  • app/api/ - API routes for article views and Spotify integrations.
  • app/writing/ - Blog posts written in MDX format (Markdown in JSX).
  • components/ - All the components of the website in tsx format.
  • lib/ - Useful functions and scripts for connecting to external services and so on.
  • public/ - Used for static files such as icons and images.
  • styles/ - Contains the stylesheets for Tailwind and Prism.
  • types/ - Types for various components in the project.

Running locally

This application requires node v16.14+.

git clone https://github.com/r-freeman/portfolio.git
cd portfolio/
npm i
npm run dev

Create a .env.local file using .env.example as a template.