Skip to content

bsandeepan/gcv-spa-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project: GlitchCV Website Template

Details : A CV/Portfolio Single Page Website template for individual use with custom CLI-based CMS, helping you to change information in your CV website as you require. Beware! There will be a Glitch in your CV! :)

License Info : GlitchCV SPA (also known as GCV SPA) uses two separate licenses -

  1. the code structure and underlying logic of GCV SPA template is licensed under GNU General Public License v3. The author requests all users, and developers who modify the source code, to not remove the existing footer credit. To view a copy of this license, See the local LICENSE-code file.

  2. Creative Commons License All dummy content and original artowork(s) in GCV SPA by Sandeepan Bhattacharyya is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. To view a copy of this license, See the local LICENSE-content file or visit http://creativecommons.org/licenses/by-nc-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. Aside the dummy data content, this license also ,without any exception(s), covers -

    • The existing logo image of GCV SPA created by Sandeepan Sengupta.
    • The content of all markdown files and all documentation comments found in files in ./src folder of this project.

Table of Contents:

Annoucement:

Version 1.0.0 has been released! Kindly check the releases. If you detect any bugs, kindly raise an issue. Thanks!

Introduction:

GlitchCV is a personal single page static CV/Portfolio website template. It is minimalistic, user-friendly, fully responsive, and most-importantly, "dynamically static".

For most static website templates out there, you need to look up a bit of HTML and CSS to set them up. I, however, wanted to make a web template where I can just plug in data somewhere separately, and it will be set. Therefore, I designed a Command Line based CMS Interface for GlitchCV to use to load the data dynamically (without any server-side code!) via front-end rendering. You can say it's like a flat-file CMS (for example - Grav), but it's not as interactive and advanced (and definitely does not have a GUI!) as it sounds. However, the headache of figuring out how to fit the new content you want to insert is significantly reduced.

GlitchCV is completely open-source and free to use. Also, the website changes its color daily!

Usage:

This template is easy to figure out (or so I tried to make). All you need to do is fill in the necessary data in the JavaScript files located in ./resources/ in the project directory. Go to User Manual to learn how to configure the website.

To start, you need to know how to work with JS Object format. You can start by reading the official MDN docs and this W3Schools JS Object Intro.

  • data.js file contains all of your necessary information to configure the website. This KEY file should be updated whenever you want to make any changes in content.
  • settings.js file contains few dynamic settings information. In most cases, you may not need to configure this file at all. Ideally, unless you know how Arrays, CDNs, Fallback Methods work, you should not touch this file with confidence.

Proceed to User Manual to learn more.

Future Improvements:

I have these improvements in mind -

  1. Changing the cms files into JSON: I wanted to use JSON files instead of JS for loading data and settings since the start. I tried and I failed repeatedly. As my self-committed deadline approached soon, I had to put it aside and use .js files to load data. So, there is one improvement I have in mind. Or is using JS files better here? Well, I guess JS files are taking less space and if you, the user, want to minify them to use, it will take even less space.
  2. I want to integrate a clients section. This section will have a Moving display.
  3. I am having ecod thoughts about using percetages to explain your skills. To me, that's simply pretentious. However, many are so I guess I will add it as a feature.

If you think you can make any improvements here (incl. the above sighs), fork the project, add your improvements and open a pull request. I will check it and discuss with you.

Resources:

CSS: Bulma Framework
Icons: FontAwsome and Devicon


Thanks!