Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 2.85 KB

README.md

File metadata and controls

86 lines (55 loc) · 2.85 KB

gatsby-resume-template

Gatsby.js V2 starter template based on gatsby-starter-resume.

Check online preview here.

Screenshot

Screenshot

Install

Make sure that you have the Gatsby CLI program installed:

npm install --global gatsby-cli

And run from your CLI:

gatsby new <site-name> https://github.com/cto-ai/gatsby-resume-template

Then you can run it by:

cd <site-name>
npm install
gatsby develop

Personalization

Edit config.js with your details:

const REPOSITORY = 'resume'
const FIRST_NAME = 'Jane'
const LAST_NAME = 'Doe'
const GITHUB_USERNAME = 'awesome-developer'
const TWITTER_USERNAME = 'awesome-developer'
const LINKEDIN_USERNAME = 'awesome-developer'
const PHONE_NUMBER = '604-XXX-XXXX'
const ADDRESS = 'Vancouver'
const EMAIL = 'jane.doe@email.com'
const FOOTER_URL = 'https://www.cto.ai'

const BIO = ...

const EXPERIENCE_LIST = ...

const EDUCATION_LIST = ...

const LANGUAGES_AND_TOOLS = ...

const SKILLS = ...

const PORTFOLIO = ...

const CERTIFICATIONS = ...

Automated deployment to Github pages using Github actions

package.json has a default script that uses gh-pages module to publish on Github pages. Simply running npm run deploy would publish the site on Github Pages.

Additionally, it also has path-prefix value set for gatsby config in config.js as REPOSITORY. Change REPOSITORY to relevant path if your gatsby site is hosted on subpath of a domain, https://domain.com/somePath/. If you are hosting it as root site, i.e, https://domain.com/ , remove the pathPrefix configuration entirely or set it an empty string.

The present project leverages Github Actions for automated deployment to Github pages. Any push to the master branch will trigger the workflow that builds and pushes the built code to the gh-pages, triggering a deployment. In order for the deployment to work, it is necessary for the repository to be configured correctly for Github Pages, as well as for an ACCESS_TOKEN secret to be set up in the repository. To generate it, go to Personal access tokens and create a new token with the repo scope enabled.

Contributing

See the Contributing Docs for more information.

Contributors


Ruxandra Fediuc

License

MIT