This is a personal website template built with Next.js. Next.js is a React framework that enables functionality such as server-side rendering and generating static websites for React-based web applications.
This template serves as a starting point for developers seeking to create their own online portfolio or personal website. The site is flexible, customizable and straightforward to deploy. There are TODO's in some places to get you started.
This website template is built with:
- Next.js (React Framework)
- HTML/CSS
- JavaScript
- TypeScript
These instructions will get you a copy of the project up and running on your local machine for development purposes.
-
Clone the repo:
git clone https://github.com/your-github-username/next-website-template.git
-
Navigate into the project directory:
cd next-website-template
-
Install the dependencies:
npm install
--or-yarn install
-
Run the development server:
npm run dev
--or--yarn dev
Open http://localhost:3000/hello with your browser to see the result. As you make edits to the project, the page will auto-update. When you are ready to deploy, remove 'hello' from next.config.js.
Deploying this website to GitHub Pages requires a few additional steps:
-
Build the project:
npm run build
--or--yarn build
-
Deploy the project to GitHub Pages:
npm run deploy
--or--yarn deploy
-
Update the CNAME file with your domain name.
To configure a custom domain from Google Domains with your GitHub Pages:
- Go to your Google Domains account.
- Click the domain name you want to use for your GitHub Pages.
- Scroll down to the "Custom resource records" section.
- In the first row, leave the "@" in the name.
- Select "CNAME" from the dropdown.
- In the "Domain name" section, put your
<username>.github.io
. - Save the changes and it should be good to go.
Contributions are very much welcome. Feel free to fork, modify, and submit pull requests. If you find bugs, please open an issue or submit a pull request with a fix.
For any questions or feedback, please reach out to the project owner or open an issue on GitHub. Happy coding!
Thanks to Next.js and the Open Source Community for making this possible.