Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mldangelo/personal-site
My personal website - built with React, React-Router, React-Snap for Static-Export, and GitHub Pages.
https://github.com/mldangelo/personal-site
github-page javascript personal-website portfolio portfolio-website react resume resume-website serverless webpack
Last synced: about 11 hours ago
JSON representation
My personal website - built with React, React-Router, React-Snap for Static-Export, and GitHub Pages.
- Host: GitHub
- URL: https://github.com/mldangelo/personal-site
- Owner: mldangelo
- License: mit
- Created: 2014-11-14T09:20:19.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2025-01-20T02:40:33.000Z (18 days ago)
- Last Synced: 2025-01-30T13:11:21.159Z (8 days ago)
- Topics: github-page, javascript, personal-website, portfolio, portfolio-website, react, resume, resume-website, serverless, webpack
- Language: SCSS
- Homepage: https://mldangelo.com
- Size: 15.8 MB
- Stars: 1,388
- Watchers: 19
- Forks: 920
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
README
# Personal Website
Welcome to my [personal website](https://mldangelo.com)! This is an [MIT licensed](https://github.com/mldangelo/personal-site/blob/main/LICENSE) React-based Jamstack application. It offers a simple interface, easy modifications, static export capabilities, and free automatic deployments via [GitHub Pages](https://pages.github.com/).
## 🚀 Features
- Built with modern JavaScript, using tools and frameworks like [create-react-app](https://github.com/facebook/create-react-app), [React-Router](https://reactrouter.com/), and SCSS.
- Automated workflows via [GitHub Actions](https://github.com/features/actions).
- And more!
## 🛠 Adapting this Project
Want to create your own personal website based on this project? You can set it up in as little as 30 minutes! Follow the setup instructions below and check out the **[detailed guide and checklist](./docs/adapting-guide.md)** on adapting this project to your needs. If you encounter any challenges, don't hesitate to contact me through an issue or email at [[email protected]](mailto:[email protected]).
## 🤝 Contributing
Your contributions are warmly welcomed! If you wish to contribute, please review the [design goals](./docs/design-goals.md), [roadmap](./docs/roadmap.md), and [contributing guidelines](./docs/contributing.md). For any bugs or suggestions, you can reach out via email, submit a pull request (I'd be happy to get you a coffee as a thank-you!), or open an issue.
## 🔧 Dependencies
Ensure you have [node](https://nodejs.org/) >= v16. Optionally, use [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) to manage node versions.
## 🚀 Setup and Running
1. Clone the repository:
```bash
git clone git://github.com/mldangelo/personal-site.git
cd personal-site
```
2. (Optional) Ensure you're on Node v16 or higher:
```bash
nvm install
node --version
```
3. Install dependencies:
```bash
npm install
```
4. Start the application:
```bash
npm start
```
By default, the application should be available at [http://localhost:3000/](http://localhost:3000/).
## 🚢 Deploying
### Deploying to GitHub Pages
1. Update the environment variables and Git remote URL in [`.github/workflows/github-pages.yml`](.github/workflows/github-pages.yml).
2. Adjust the `homepage` value in `package.json` based on your hosting preferences.
3. Planning on using a custom domain? Update `public/CNAME`. Otherwise, remove it.
After making a commit to `main`, simply push your changes, and the deployment will be handled automatically.
### Static Export
For a static export without deploying to GitHub Pages:
- Remove or disable `.github/workflows/github-pages.yml`.
- Execute:
```bash
npm run predeploy
```
This will generate a static version in `personal-site/build/` which you can host or deploy to a CDN.
## 🙌 Acknowledgements
- Initial template from [Future Imperfect](https://html5up.net/future-imperfect) by [@ajlkn](https://github.com/ajlkn) for [HTML5 UP](html5up.net).
- Special thanks to [@typpo](https://github.com/typpo) for tirelessly answering all of my node.js and react questions.
- Kudos to [@notrueblood](https://github.com/notrueblood)[[1]](https://github.com/mldangelo/personal-site/pull/218) and [@sjhsieh](https://github.com/sjhsieh)[[2]](https://github.com/mldangelo/personal-site/issues/168) for their constructive feedback.