Nathan Cummins
9445b3f2e3
Some checks are pending
Build and Deploy to Web Server / deploy (push) Has started running
56 lines
2.6 KiB
Markdown
56 lines
2.6 KiB
Markdown
# Portfolio Website
|
||
|
||
## [nathancummins.com.au](https://www.nathancummins.com.au)
|
||
|
||
This repo contains the source and creative materials for my personal portfolio website at [nathancummins.com.au](https://www.nathancummins.com.au) which showcases my projects, skills, music, and biography.
|
||
You are free to use any code in this repository under the conditions of the license as described below and in the [LICENSE file](LICENSE).
|
||
|
||
Thanks for checking it out!
|
||
|
||
## TL;DR
|
||
|
||
- **Code:** All source code in this repository is licensed under the [MIT License](LICENSE). You are welcome to fork, clone, modify, or otherwise use the code in your own projects, provided you give appropriate credit.
|
||
- **Non-code content:** All other materials — including music and audio (melodies, harmonies, arrangements, lyrics, sound recordings, and other musical elements and audio), images, photographs, written biographies, project descriptions, and any other creative works — are copyright © 2025 Nathan Cummins, **all rights reserved**. These may not be copied, modified, distributed, or otherwise used without prior written permission.
|
||
|
||
If you use the code, I would appreciate proper credit by linking back to my [website](https://www.nathancummins.com.au) or including my name and email ([nathan@nathancummins.com.au](https://www.nathancummins.com.au)).
|
||
|
||
I’d also love to see what you've made — feel free to get in touch!
|
||
|
||
## Built With
|
||
|
||
This website was built primarily with the following technologies:
|
||
|
||
- [Astro](https://astro.build)
|
||
- Node.js
|
||
- Tailwind CSS
|
||
- Visual Studio Code (with the following plugins in addition to the recommended Astro plugins and other plugins that I use regularly)
|
||
- Prettier
|
||
- ESLint
|
||
- Howler.js (for the backend of the audio player)
|
||
|
||
## Features
|
||
|
||
**🎵 A persistent audio player that works across all pages**
|
||
|
||
**📄 Finally (for me!) a multi-page layout that's easy to add more content to**
|
||
|
||
**📱Fully responsive**
|
||
|
||
**🕶️ Built with dark mode and other accessibility features in mind**
|
||
|
||
## Installation and Setup
|
||
|
||
1. Install prerequisites (Node.js)
|
||
2. Run `npm install`
|
||
3. From the root of the project directory, run `npm run dev` to start the development server which automatically refreshes on content changes
|
||
|
||
## Building and Deploying
|
||
|
||
To build, as with most Astro projects, simply run `npm run build`, which currently outputs the built website to the `dist` folder.
|
||
Eventually, this website will automatically deploy via my custom-built deployment system and self-hosted server environment (todo!).
|
||
|
||
## Show your support
|
||
|
||
You sharing my website is all the support I need.
|
||
However, if you'd like to support me in any other way, please feel free to get in touch!
|