Skip to content

Commit

Permalink
Updated README for Next.js
Browse files Browse the repository at this point in the history
  • Loading branch information
jstamant committed Jan 22, 2024
1 parent d1a4f16 commit 318bfc1
Showing 1 changed file with 22 additions and 15 deletions.
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,35 @@
# [My Portfolio Website](https://jstamant.com/portolio)

Here's the repository for my [personal portfolio
website](https://jstamant.com/portfolio).

This website is a static site generated by [Hugo](https://gohugo.io/). I figured
this would be the best option for making a portfolio site, as using a platform
like `Next.js` would be overkill for making such a simple, non-interactive site.
The site also uses [TailwindCSS](https://tailwindcss.com/) as a CSS framework.

Here's the repository for my [personal portfolio website](https://jstamant.com/portfolio).

This website is a static site generated by [Next.js](https://nextjs.org/).
I chose *Next.js* because of the unique nature of the website.
Because this site has the potential to serve all sorts of different content, I figured using *Next* would be a good solution.
This site does not serve content the way a CMS does (using layouts/templates for many pages), a more app-like approach would better serve this portfolio site.
The site also uses [Tailwind CSS](https://tailwindcss.com/) for CSS styling.

![screenshot](/screenshot.png)

I could've used plain HTML with a CSS framework, but I went with Hugo to
separate the markdown from the content. ...Which is probably overkill for a
single-page site...
I could've used plain HTML with a CSS framework, but I went with *Next* to support the variety of content that might end-up on this website, as well as support any interactivity I might want to add.

The inspiration for the design comes from [Ram Maheshwari](https://www.rammaheshwari.com/)'s
[Dopefolio](https://github.com/rammcodes/dopefolio) template.
The inspiration for the design comes from [Ram Maheshwari](https://www.rammaheshwari.com/)'s [Dopefolio](https://github.com/rammcodes/dopefolio) template.

## Running

To work on the website in development, run the following commands in separate
processes:
To work on the website in development, run:

```
npm run dev
```

## Building & Deploying

To build the website, run:

```
npm run tailwind
npm run hugo
npm run build
```

This will generate the `out/` folder, which you can easily deploy to any web server, or to Netlify or GitHub pages.

0 comments on commit 318bfc1

Please sign in to comment.