aswinzz / lucidcv Goto Github PK

CV Maker :rocket:

Home Page: https://lucidcv.herokuapp.com/

JavaScript 19.45% HTML 33.67% CSS 46.88%

cv-template cv-maker nodejs npm express materialize

lucidcv's Introduction

LucidCV

LucidCV is a simple CV maker which collects data from the user and creates a CV for the user. You can select the CV theme that you need and after creating the CV you can download a copy of it. Those who wish to contribute are welcome 😄 .

How to setup locally

Install nodejs and npm
run git clone https://github.com/aswinzz/LucidCV.git
Enter into the cloned folder
run sudo npm install
run sudo npm start
Go to localhost:3000 in your browser

How It Works

The user enters the data and after the form is submitted a json file is created and depending on the selected theme and the json data CV is prepared.

File Structure :
- The folder Public contains the css,javascripts and images needed for the website
- The folder Views contains the code of homepage and cv templates,they are in ejs format(embedded javascript).
  - index.ejs : contains the code for homepage which contains the form that takes the details of the users.I have used materialize css as the frontend framework.
  - resume.ejs : What this code does is, format the json data obtained from the user into a CV.
- The folder routes contains a file index.js this file creates the json file when the user submits the form using a POST request and formats the resume.ejs file.

TODO

See todo.md for features to be added

Happy Contributing 😊

Anyone who wish to contribute to this repo can add yourself in the contributors.md and can start solving issues. You can also create issues for the problems that you came across in the project.

How to contribute?

First, verify if there's no one already working on solving the issue.
Star and Fork the repository to start working on it.
Clone the repository in your local machine using $ git clone [email protected]:YOUR-GITHUB-USER-NAME/LucidCV.git
Visit your fork on (https://github.com/YOUR-USER-NAME/LucidCV) and create a pull request for your changes.
Make sure your pull request describes what you changed and references the issue that you're fixing.

How to integrate theme into website ?

First , create a file in views folder name as theme1(2,3..).ejs for reference you can use resume.ejs.
Goto index.ejs file and add a option of your file just like given example below.
Now integrate your theme into website by going to routes->index.js and configure the portion shown below with your theme.
Congrats you integrated your theme to website !

lucidcv's People

Contributors

Stargazers

Watchers

Forkers

pani-vishal arpitmisraw ak-007 nityanandagohain aadixiiita adityaraj-xtc namantw tachyon01 esha23 shivhek25 hiteshpr ekanban surasnayak tlazypanda rudransh1 akansha006 danielfernades pedrocssg cquon mohancm racistpanda pseudonerd alnazinamdar mkkhedawat richatripathi17 arpitv424 timikcool chronos25 guptasidharth1 amay28 radhikav30 rashisr19 mishra-27 sanghaimuskan irfansener zunaid24 shradha14 manan012 aishwarya4787 paridhijain212 kaysiz aditvil harshithmullapudi njackwinterofcode lovely-90 vaibhavg133 bob771025 todun thetallralph falguniajmera edusandovall mynameissomethin rabbittsh narasimmank vaimalaviya1233 adnen2019

lucidcv's Issues

Potential Security Issue

👋 Hello, we've received a report for a potential critical severity security issue in your repository.

Next Steps

1️⃣ Visit https://huntr.dev/bounties/1-other-aswinzz/LucidCV for more advisory information.

2️⃣ Sign-up to validate or speak to the researcher for more assistance.

3️⃣ Propose a patch or outsource it to our community.

Confused or need more help?

Join us on our Discord and a member of our team will be happy to help! 🤗
Speak to a member of our team: @JamieSlome

This issue was automatically generated by huntr.dev - a bug bounty board for securing open source code.

Remove the extra cards

Select tag is not showing the current option chosen

At this time the select tag is not showing the currently chosen option.

For example, here I have chosen the theme 3 but still it is showing "Choose your theme".
This would create confusion among users about the current theme and which to chose.

Suggest more issues

Comment down the issues that you find and we will create new issues for that.

UI doesn't show up on npm start

$ npm install
$ npm start

Browser : http://localhost:3000/

UI does not show up. throws 404s on many assets. Looks like structure is incorrect.

Is it just me ?

Add calendar (datepicker) to date inputs fields

Fix logo

Make CV Downloadable

As of now the user can only view the CV, make either the json file downloadable or the html code.

Add sweetalert

when submitting the form ,if the field is not filled standard popup is coming change it to sweetalert
Refer here

Add more templates

Everyone can work on this issue by adding more themes.
As of now there is only one template.We need more templates so that the users can have a choice among the templates.
When doing this issue:
* Create a new file theme2(or 3,4..).ejs in views folder and add the template accordingly (refer resume.ejs for embedding the json data)

Integrate newly added themes to the website

after creating the templates. they must be added to the form and according to the selection.
For that edit index.ejs and add the theme to the theme selection option.Then in routes->index.js render the required theme according to the user selection.

Add new features to todo.md

How to contribute markdown file

create a how_to_contribute.md file in which steps to contribute will be added

Create contributors.md

create a contributors.md file and add yourself as a contributor

Create a Pull Request template

add steps to contribute

Add this in the how_to_contribute.md file (once it is made)

How To Contribute To This Repo!

NOTE: PR's will be merged if you star the repo!!

Star This Repo
Fork This Repo To Your Account
Add Yourself To The CONTRIBUTING.md file
Create A PullRequest
- Make sure to include the issue number and a link to a gh page for your contribution as shown in PULL_REQUEST_TEMPLATE.md
Solve issues
You can also create new issues which you think needs to be added in this Repo.
Enjoy Contributing 😊