How to edit a resume theme

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.

Get the resume server up and running

1. Clone the github repository
2. Install the npm packages npm install
3. 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
4. Run resume serve --theme .. This will open the browser on port 4000 with the resume.

Edit the resume

1. The file resume.hbs or resume.handlebars is the most important file in the repo
2. All the code for the resume creation may be present in this file
3. There may also be a partials folder
4. If you want to use your own partials, you might have to edit the index.js file
5. Edit these files and restart the server to view changes
6. Handlebars Documentation
7. The project may use Vanilla CSS or SCSS. This is generally in the styles.css or styles.scss file.

Publish as npm package

1. Once all the changes are done, change the name of the package in package.json file
2. Update the version number.
3. Make sure that .npmignore file exists. We do not want node_modules folder to be pushed to the npm repo. Hence we add this file here.
4. Login to npm on the CLI
5. Publish to the npm repository. npm publish. (Currently this can only be done by me as the packages are in my account)

Update the cvengine-frontend repository

2. Move to the server2 directory and uninstall the npm packages of the themes.
3. Globally uninstall the npm packages of the themes to clean up your system
4. Now install the new themes in the server2 directory and globally
5. Change the name of the themes in infra/nodePlaybook.yaml directory
6. Run the client and server locally and check
7. Push code, deploy and check in production