54 lines
2.4 KiB
Markdown
54 lines
2.4 KiB
Markdown
# Portfolio Website
|
|
|
|
## [nathancummins.com.au](https://www.nathancummins.com.au)
|
|
|
|
This repo contains the source for my personal portfolio website at [nathancummins.com.au](https://www.nathancummins.com.au) that features projects bios, skills, music, and projects that I have worked on.
|
|
Thanks for checking it out!
|
|
|
|
## TL;DR
|
|
|
|
Please feel free to fork, clone, modify, or otherwise make use of any source code in this website for your own projects.
|
|
This does not include all copyrighted materials (or any materials that are otherwise intellectual property), including audio files, imagery, and some text relating especially relating to projects or biographical information.
|
|
I kindly request that you refrain from obtaining any of these materials via any method.
|
|
|
|
If you use anything from this repository I would appreciate proper credit by linking back to my [website](https://www.nathancummins.com.au) or at least by including my name and email address ([nathan@nathancummins.com.au](https://www.nathancummins.com.au)).
|
|
I'd also love to know how you have made use of it - reach out and let me know and I'd love to see what you've done!
|
|
|
|
## 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!
|