From c1801a9e077c410ba1a543b52c8e3bfb393443d3 Mon Sep 17 00:00:00 2001 From: r-freeman Date: Sat, 21 Jan 2023 23:38:13 +0000 Subject: [PATCH] Updated README --- README.md | 46 +++++++++++++++++++++++++++++++++------------- 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f3bb5d8..d320e2b 100644 --- a/README.md +++ b/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. \ No newline at end of file +- `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. \ No newline at end of file