Code Monkey home page Code Monkey logo

personal-site's Introduction

Personal Website

Welcome to my personal website! This is an MIT licensed React-based Jamstack application. It offers a simple interface, easy modifications, static export capabilities, and free automatic deployments via GitHub Pages.

๐Ÿš€ Features

๐Ÿ›  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 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].

๐Ÿค Contributing

Your contributions are warmly welcomed! If you wish to contribute, please review the design goals, roadmap, and contributing guidelines. 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 >= v16. Optionally, use nvm to manage node versions.

๐Ÿš€ Setup and Running

  1. Clone the repository:

    git clone git://github.com/mldangelo/personal-site.git
    cd personal-site
  2. (Optional) Ensure you're on Node v16 or higher:

    nvm install
    node --version
  3. Install dependencies:

    npm install
  4. Start the application:

    npm start

By default, the application should be available at http://localhost:3000/.

๐Ÿšข Deploying

Deploying to GitHub Pages

  1. Update the environment variables and Git remote URL in .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:

    npm run predeploy

This will generate a static version in personal-site/build/ which you can host or deploy to a CDN.

๐Ÿ™Œ Acknowledgements

personal-site's People

Contributors

mldangelo avatar dependabot[bot] avatar greenkeeper[bot] avatar typpo avatar notrueblood avatar nickspaargaren avatar rayliuca avatar shamepoo avatar snyk-bot avatar will-holley avatar yangzhou0 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.