Skip to content

Commit

Permalink
Merge pull request #1 from SHIINASAMA/rewrite
Browse files Browse the repository at this point in the history
Rewrite
  • Loading branch information
SHIINASAMA authored Nov 3, 2024
2 parents 294f300 + 9b8dd69 commit 7ac4045
Show file tree
Hide file tree
Showing 26 changed files with 5,845 additions and 342 deletions.
3 changes: 3 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": ["next/core-web-vitals", "next/typescript"]
}
22 changes: 22 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: GitHub Pages

on:
push:
branches:
- main

job:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build
runs: |
npm install
npm run build
- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4
withs:
folder: out
43 changes: 43 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/versions

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# env files (can opt-in for commiting if needed)
.env*

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts

/.idea
/.vscode
56 changes: 23 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,36 @@
# Simple Website Using Github Pages
Make a simple HTML website and publish it using Github Pages.
View example: https://zirafa.github.io/simple-website-template/
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).

## Setup
- Create a Github account (if you don't have one yet)
- Fork this repository to copy it to your account, i.e. github.com/username/simple-website-template (you can rename it as well)
- Make sure you see the gh-pages branch (it should be the default)
- Edit website files on the gh-pages branch, then wait a minute or two for Github Pages to update and deploy your site.
- View your site: https://username.github.io/simple-website-template
## Getting Started

## How does this work?
This website template uses CSS & JS to hide and show different parts of index.html and uses Github Pages to render the website from the gh-pages branch.
First, run the development server:

## Things to try
- Edit index.html and change the title of the page
- Edit index.html and change the content displayed in home, about, and contact.
- Edit index.html and change the content in the footer region.
- Replace logo.jpg and background.jpg with your own images.
- Update the metadata in the header portion of index.html (this is used by search engines and browsers).
- Edit style.css and change the link color and font style.
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

## Further reading
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

### Can I make separate HTML files for each page?
You can use Javascript AJAX calls to pull in external content into your index.html page. See script.js for more details.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

### Can I configure a custom domain for my site, i.e. johnnymakerportfolio.com?
Yes! Github Pages supports [custom domain configuration](https://help.github.com/en/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site). However, you will need to buy a domain name from a registrar such as [NameCheap](https://www.namecheap.com/) or [Gandi](https://www.gandi.net/) -- the cost is usually around $10 - $15 a year.
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.

### Can I add a blog, etc?
This template works best for simple sites. For a blog you can try setting up [Jekyll, which is a static site generator that also works on Github pages](https://help.github.com/en/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll). For even more functionality, you will probably need a content management system (CMS) such as [Wordpress](https://wordpress.com), [Drupal](http://drupal.org), or [Django](https://www.djangoproject.com). A CMS will require additional setup and a website host, such as [Dreamhost](https://www.dreamhost.com/).
## Learn More

### Can I add a store?
If you are interested in selling products online, check out [BigCartel](www.bigcartel.com), which lets you setup a storefront with 5 products for free.
To learn more about Next.js, take a look at the following resources:

### I heard I need to be using XYZ framework (Bootstrap, React, etc).
Web technology changes rapidly, and it easy to get lost in the hype. Learning the basics of HTML, CSS, and JS is a good place to start. From there, you can explore different frameworks and libraries to see what interests you.
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

### I don't want to write code or deal with website hosting. Are there any website builders you recommend?
- Google Sites (free)
- Squarespace
- Wix
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
79 changes: 0 additions & 79 deletions index.html

This file was deleted.

Binary file removed logo.png
Binary file not shown.
7 changes: 7 additions & 0 deletions next.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import type {NextConfig} from "next";

const nextConfig: NextConfig = {
output: 'export'
};

export default nextConfig;
Loading

0 comments on commit 7ac4045

Please sign in to comment.