Note: This document outlines the general process of editing these themes. The actual implementation may vary depending on the project structure or templating engine used by the independent developers.
- Clone the github repository
- Install the npm packages
npm install
- Create a new file called
resume.json
. This should have all the fields mentioned in our resume form. This file can simply be copied from our main repository. https://gitlab.com/vforeseetech/cvengine-frontend - Run
resume serve --theme .
. This will open the browser on port 4000 with the resume.
- The file
resume.hbs
orresume.handlebars
is the most important file in the repo - All the code for the resume creation may be present in this file
- There may also be a
partials
folder - If you want to use your own partials, you might have to edit the
index.js
file - Edit these files and restart the server to view changes
- Handlebars Documentation
- The project may use Vanilla CSS or SCSS. This is generally in the
styles.css
orstyles.scss
file.
- Once all the changes are done, change the name of the package in
package.json
file - Update the version number.
- Make sure that
.npmignore
file exists. We do not wantnode_modules
folder to be pushed to the npm repo. Hence we add this file here. - Login to npm on the CLI
- Publish to the npm repository.
npm publish
. (Currently this can only be done by me as the packages are in my account)
- Move to the
server2
directory and uninstall the npm packages of the themes. - Globally uninstall the npm packages of the themes to clean up your system
- Now install the new themes in the
server2
directory and globally - Change the name of the themes in
infra/nodePlaybook.yaml
directory - Run the client and server locally and check
- Push code, deploy and check in production