Skip to content

Commit 318bfc1

Browse files
committed
Updated README for Next.js
1 parent d1a4f16 commit 318bfc1

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,35 @@
11
# [My Portfolio Website](https://jstamant.com/portolio)
22

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

6-
This website is a static site generated by [Hugo](https://gohugo.io/). I figured
7-
this would be the best option for making a portfolio site, as using a platform
8-
like `Next.js` would be overkill for making such a simple, non-interactive site.
9-
The site also uses [TailwindCSS](https://tailwindcss.com/) as a CSS framework.
4+
5+
Here's the repository for my [personal portfolio website](https://jstamant.com/portfolio).
6+
7+
This website is a static site generated by [Next.js](https://nextjs.org/).
8+
I chose *Next.js* because of the unique nature of the website.
9+
Because this site has the potential to serve all sorts of different content, I figured using *Next* would be a good solution.
10+
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.
11+
The site also uses [Tailwind CSS](https://tailwindcss.com/) for CSS styling.
1012

1113
![screenshot](/screenshot.png)
1214

13-
I could've used plain HTML with a CSS framework, but I went with Hugo to
14-
separate the markdown from the content. ...Which is probably overkill for a
15-
single-page site...
15+
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.
1616

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

2019
## Running
2120

22-
To work on the website in development, run the following commands in separate
23-
processes:
21+
To work on the website in development, run:
22+
23+
```
24+
npm run dev
25+
```
26+
27+
## Building & Deploying
28+
29+
To build the website, run:
2430

2531
```
26-
npm run tailwind
27-
npm run hugo
32+
npm run build
2833
```
34+
35+
This will generate the `out/` folder, which you can easily deploy to any web server, or to Netlify or GitHub pages.

0 commit comments

Comments
 (0)