Skip to content

Latest commit

 

History

History
90 lines (52 loc) · 6.02 KB

adapting-guide.md

File metadata and controls

90 lines (52 loc) · 6.02 KB
Raw

Adapting this Website

Many people have contacted me about adapting this website. I have tried to make things as simple as possible. There are still bugs. I am sorry. If you find a bug, please email me ([email protected]), submit a pull request (I'll buy you a coffee as a thank you), or submit an issue.

You may wish to fork this repository or remove my remote origin and add your own. Go here for more information on how to change remotes.

Before you start

  1. Make sure you have a good text editor. I recommend Visual Studio Code.
  2. Review src/App.js. This file contains all of our route definitions. If you wish to add or remove a page, you should do so here.

Checklist

Setup

  1. Run the project before making any modifications by following the set up and running instructions in the main README.md.

  2. Change homepage in package.json to reflect where you plan to host the site. This is important for static exporting via react-snap. This also changes your path when developing locally. For example, a homepage of mldangelo.com places the site at localhost:3000 and a homepage of https://mldangelo.github.io/personal-site/ places the site at localhost:3000/personal-site/. If you plan to host at on a path such as https://[your-github-username].github.io/[your-repo-name], you should set this now so that your development environment mirrors your production environment.

  3. Create a .env file. To do this, run:

    cp sample.env .env

    and set values as appropriate. Most people will not need to modify this file.

Adapt Content

I recommend keeping the project running as you go (with npm start) to help correct mistakes quickly.

  1. Start by changing text in the sidebar. This file is located at src/components/Template/SideBar.js.
  2. Add an image of yourself in public/images/me.jpg. Your image should be approximately 256 x 256 pixels. Larger and smaller is ok, but avoid very large images to save bandwidth. If you need help resizing your image, Adobe makes a great online tool here.
  3. Modify the text on the homepage. This file is located at src/pages/Index.js.
  4. Modify the files in src/data/resume/ next.
  5. Modify all of the other files in the src/data/ directory.
  6. You've finished modifying >95% of the pages. Search through the rest of the files for references to Michael or Angelo and change values to your name.
  7. Change or remove the favicon in public/index.html. This website may be helpful.

Deploy

See deployment instructions here. If you plan to use a custom url, modify public/CNAME and enter your URL. You can run:

echo "[your-custom-domain][.com]" > public/CNAME

as a shortcut.

I recommend purchasing your own domain name from Google Domains. The project is pre-configured to automatically deploy to github pages via the deploy github action. Go to https://github.com/[your-github-username]/[your-repo-name]/settings and configure accordingly:

Next, configure your domains DNS record. See here for more information. After a few minutes, your website should be live on your domain.

That's it. Thank you for reading. If you go through this guide and run into issues or areas you find unclear, please consider submitting a PR to help others like you.

Common Pitfalls

Here are answers to questions I've been asked at least twice. I've attempted to simplify development and improve documentation throughout the project to address them. This section is updated frequently.

  1. My CSS isn't rendering, or I see a 404 instead of my site:

    Make sure the homepage field of package.json points to where you plan to host your site index. Also, double check that you created a CNAME file (see deployment instructions above). If neither of these work, please open an issue or send me an email.

  2. LF / CRLF issues with eslint.

    This is a common Windows development pitfall. See @FrozenFury's comment for how to update your eslint config to resolve this issue.

  3. master / main

    Github decided to rename the default branch of all of their repositories from master to main, and so did I. See their reasoning here. If you're trying to pull in recent changes, consider renaming your own branch, or just create a merge commit from my main.

  4. Google Analytics Warnings when exporting.

    Either set up Google Analytics or disable the Analytics.js component. Read more about react-ga.

  5. How do I configure git? What is nano?

    Read through git-scm's excellent documentation. I recommend setting your default text editor to something you're comfortable with.I like to use vim for writing commit messages.

  6. Can I host at [username.github.io]?

    Sure, see github's documentation here.

  7. How do I disable eslint?

    echo "*\n" > .eslintignore Although I really don't recommend it. Linters are good. They help prevent errors, enforce uniform style so that you can spend less time thinking about formatting and more time reading code, and eliminate easy nits for code reviews. If the rules aren't working for you, you should change them. See eslint's documentation here for more information.

  8. Why is my website rendering the readme file?

    See 1. above and make sure that .nojekyll still exists in public. This file directs github to not attempt to render the website with Jekyll.