(Back to top)

About

Resume Site of Higama-ya, hosted on GitHub Pages, and can be accessed at url: https://about-me.higamaya.com/

This site uses Materialize front-end framework and is developed based on Parallax Template.

You can use this project as a template to make your own Resume Site.

(Back to top)

Built With

• Materialize
• anime.js
• Chart.js
• jQuery
• Material icons
• Font Awesome

(Back to top)

Usage

Setup

1. Duplicate the repo

Duplicate this repo, and clone it to your computer.

See GitHub Docs if you want to know the way to duplicate a repo.

2. Install NPM packages

npm install

(Back to top)

Development

1. Make source files

All source files that make up the site, such as *.html, *.css and *.js, are stored in src directory.

2. Test with browser

Run local HTTP server.

npm run server

The HTTP server refers src directory as document root. Access port 8080 to test the site with browser.

The local HTTP server allows you to test with mobile devices within the local network. If you don't need to test with mobile devices, you can also test by opening HTML files in the src directory by browser directly.

(Back to top)

Build to publish

Build the site to publish.

npm run build

The following processes are executed.

• Minify *.css and *.js files in src directory.
• Copy all files from src to docs directory.
• Edit *.html files in docs directory, to refer min versions of *.css and *.js.
• Minify image files such as *.png in docs directory.

Note: The build script has only been confirmed to work on Linux. So it may not work properly on Windows.

(Back to top)

Deployment

Deploy the contents of docs directory to the server that hosts your site. The procedure depends on your hosting service.

In the case of Higama-ya, the site is hosted on GitHub Pages, so all we have to do is push the commit of docs directory to the main branch.

(Back to top)

License

Distributed under a custom license based on MIT License. The difference from MIT License is that image files are excluded from the license. See LICENSE for more details.

(Back to top)

Contact

Send a direct message to Higama-ya's twitter account: @higama_ya

(Back to top)