portfolio/README.md

38 lines
1.4 KiB
Markdown
Raw Normal View History

2023-02-04 23:30:30 +00:00
[![Portfolio of Ryan Freeman](https://user-images.githubusercontent.com/30879081/216793827-c480404a-3d91-4f9b-ba4a-26eed9cadb37.jpeg)](https://ryanfreeman.dev/)
2023-02-04 11:11:01 +00:00
2023-01-21 23:38:13 +00:00
# Portfolio
2022-12-06 12:54:34 +00:00
2023-01-21 23:38:13 +00:00
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.
2022-12-06 12:54:34 +00:00
2023-01-21 23:38:13 +00:00
- Language: [TypeScript](https://www.typescriptlang.org/)
- Framework: [Next.js](https://nextjs.org/)
2023-04-10 22:20:18 +00:00
- Database: [Supabase](https://supabase.com/)
2024-08-23 18:35:59 +00:00
- Deployment: ~~[Vercel](https://vercel.com/)~~ Self-Hosted on Raspberry Pi 5
2023-01-21 23:38:13 +00:00
- Styling: [Tailwind CSS](https://tailwindcss.com/)
- Integrations: [Spotify](https://spotify.com/)
2022-12-06 12:54:34 +00:00
2023-01-21 23:38:13 +00:00
## Project structure
2023-01-14 19:31:05 +00:00
2023-08-01 17:52:28 +00:00
- `app/` - App router.
- `app/api/` - API routes for article views and Spotify integrations.
- `app/writing/` - Blog posts written in MDX format (Markdown in JSX).
2023-01-22 20:48:20 +00:00
- `components/` - All the components of the website in tsx format.
2023-01-21 23:38:13 +00:00
- `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+.
```bash
git clone https://github.com/r-freeman/portfolio.git
cd portfolio/
npm i
npm run dev
```
2023-08-01 17:52:28 +00:00
Create a `.env.local` file using `.env.example` as a template.