anipalur.com

Source code for my personal website.

GPL-3.0 License

Stars
0
Committers
2

anipalur.com hugo-badge status-badge codefactor-badge

This repository hosts the source code for my website, anipalur.com - a fast, secure and flexible static site built with Hugo and hosted by Cloudflare Pages.

Adapting this Project

Feel free to fork this project and customise it for your use. See the Quickstart guide for steps on getting started.

If you have any questions, see SUPPORT.md or contact me.

Quickstart

Follow these steps to get started with running this project locally.

Prerequisites

* See Coder's theme.toml file for the minimum Hugo version required.

** Node.js comes with npm when downloaded. npm is used for test and build scripts.

Installation

Follow these steps to install this project locally.

  1. Open a CLI (e.g. PowerShell, Terminal, etc.).

  2. Navigate to a folder you want to clone this repository into.

  3. Clone this repository.

    git clone https://github.com/anipalur/anipalur.com.git
    
  4. Navigate to the project folder.

    cd anipalur.com
    
  5. Install all dependencies.

    npm install
    

Development Server

Preview the website using the following command.

npm run test

Alternatively, if you are using Visual Studio Code, use Quick Open (CTRL + P), type 'task', press space and select Test Site.

This will start Hugo's built-in development server. Visit the URL shown in the CLI (usually http://localhost:1313) to view the website. To stop the development server, use CTRL + C.

Publishing

Publish the website using the following command.

npm run build

Alternatively, if you are using Visual Studio Code, use Quick Open (CTRL + P), type 'task', press space and select Build Site.

This will publish all static files in the public directory. These files can then be used in a simple hosting environment. See Hugo's documentation on hosting and deployment for more.

Attribution

  • This website was built with Hugo using the Coder theme by Luiz F. A. de Prá.
    Portions of this theme have been modified to meet my needs.
    These modifications can be viewed in this repository.
  • Thanks to readme.so for helping create this README.md file!

Licences

Copyright © 2018-2024 Luiz F. A. de Prá Copyright © 2024 Anitej Palur The source code for this website is licensed under a GNU GPLv3 License.

See LICENSE for more information.

Badges
Extracted from project README's
hugo-badge status-badge codefactor-badge