mirror of
https://github.com/r-freeman/portfolio.git
synced 2024-11-11 18:45:41 +00:00
Updated README
This commit is contained in:
parent
36d274ee8b
commit
c1801a9e07
46
README.md
46
README.md
@ -1,17 +1,37 @@
|
||||
# Welcome to my portfolio website!
|
||||
# Portfolio
|
||||
|
||||
This website was built using 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.
|
||||
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.
|
||||
|
||||
## Features
|
||||
- Language: [TypeScript](https://www.typescriptlang.org/)
|
||||
- Framework: [Next.js](https://nextjs.org/)
|
||||
- Database: [Supabase](https://supabase.com/) (Postgres)
|
||||
- ORM: [Prisma](https://www.prisma.io/)
|
||||
- Deployment: [Vercel](https://vercel.com/)
|
||||
- Styling: [Tailwind CSS](https://tailwindcss.com/)
|
||||
- Integrations: [Spotify](https://spotify.com/)
|
||||
|
||||
- 📝 TypeScript.
|
||||
- 💨 Styled with Tailwind CSS.
|
||||
- 🌙 Toggleable dark/light mode.
|
||||
- ✍️ Personal blog with MDX (JSX in Markdown).
|
||||
- 🎵 Shows what I'm listening to on Spotify.
|
||||
- 🧮 Dynamic page view counts with Prisma/Supabase.
|
||||
- 🤖 Automated RSS feed and sitemap generation.
|
||||
## Project structure
|
||||
|
||||
Additional features will be added in the future. Feel free to explore the different sections, and contact me if you have any
|
||||
questions or would like to work together.
|
||||
- `components/` - All the components on the website in tsx format.
|
||||
- `lib/` - Useful functions and scripts for connecting to external services and so on.
|
||||
- `pages/api/` - API routes for articles views and Spotify integrations.
|
||||
- `pages/writing/` - Blog posts written in MDX format (Markdown in JSX).
|
||||
- `pages/` - Contains all other static pages like about, projects and uses.
|
||||
- `prisma/` - Prisma schema which describes the structure of the Supabase postgres database.
|
||||
- `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
|
||||
```
|
||||
|
||||
Create a `.env.local` file using `.env.example` as a template.
|
Loading…
Reference in New Issue
Block a user