CV-Generator
About this repository
This repository is a live web app deployed on Heroku. Click here to visit the web application. This web application helps users create resumes by logging into their account and filling up their details.
An API support for this application is being developed which helps distribution of user's resume data in json format that could be used by:
- companies to review user's information .
- artificial intelligence powered applications to evaluate user's json data.
- online advertisement agencies to publicize individuals so that they get hired.
With a traditional resume, the above goals are either inaccurate or cannot be used in above fields. For example, a person's name could be a skill. (say, Ruby !)
And advertisement before HRs with your skills are always a good way to upsell yourself ! :P
Technology checkup
Time to check mark technical details. The web application uses :
- Django
- A lot of Python
- HTML, CSS, JavaScript
- And your valuable time :P
Thanks for coming here !
Folder Structure
After you've cloned this repository, let's verify the folder structure.
.
│ .gitignore
│ .travis.yml
│ CONTRIBUTING.md
│ credentials.txt
│ db.sqlite3
│ LICENSE
│ manage.py
│ Procfile
│ readme.md
│ requirements.txt
│
├───.github
│ └───ISSUE_TEMPLATE
│ bug_report.md
│ feature_request.md
│
├───.vscode
│ settings.json
│
├───api
│ │ admin.py
│ │ apps.py
│ │ models.py
│ │ README.md
│ │ tests.py
│ │ urls.py
│ │ views.py
│ │ __init__.py
│ │
│ ├───migrations
│ │ │ __init__.py
│ │ │
│ │ └───__pycache__
│ │ __init__.cpython-36.pyc
│ │
│ └───__pycache__
│ tests.cpython-36.pyc
│ urls.cpython-36.pyc
│ views.cpython-36.pyc
│ __init__.cpython-36.pyc
│
├───CVGen
│ │ settings.py
│ │ urls.py
│ │ wsgi.py
│ │ __init__.py
│ │
│ └───__pycache__
│ settings.cpython-36.pyc
│ urls.cpython-36.pyc
│ wsgi.cpython-36.pyc
│ __init__.cpython-36.pyc
│
└───webapp
│ admin.py
│ apps.py
│ models.py
│ tests.py
│ urls.py
│ views.py
│ __init__.py
│
├───migrations
│ │ 0001_initial.py
│ │ 0002_auto_20180617_2059.py
│ │ 0003_auto_20180618_0327.py
│ │ 0004_auto_20180618_0329.py
│ │ 0005_auto_20180618_0329.py
│ │ 0006_auto_20180618_0329.py
│ │ 0007_auto_20180618_0331.py
│ │ 0008_auto_20180618_0332.py
│ │ 0009_auto_20180618_2135.py
│ │ 0010_auto_20180618_2213.py
│ │ 0011_auto_20180618_2213.py
│ │ 0012_auto_20180618_2238.py
│ │ 0013_auto_20180619_0423.py
│ │ 0014_auto_20180619_0426.py
│ │ 0015_auto_20180619_0432.py
│ │ 0016_auto_20180619_0442.py
│ │ 0017_auto_20180619_0451.py
│ │ 0018_auto_20180626_1218.py
│ │ __init__.py
│ │
│ └───__pycache__
│ 0001_initial.cpython-36.pyc
│ 0002_auto_20180617_2059.cpython-36.pyc
│ 0003_auto_20180618_0327.cpython-36.pyc
│ 0004_auto_20180618_0329.cpython-36.pyc
│ 0005_auto_20180618_0329.cpython-36.pyc
│ 0006_auto_20180618_0329.cpython-36.pyc
│ 0007_auto_20180618_0331.cpython-36.pyc
│ 0008_auto_20180618_0332.cpython-36.pyc
│ 0009_auto_20180618_2135.cpython-36.pyc
│ 0010_auto_20180618_2213.cpython-36.pyc
│ 0011_auto_20180618_2213.cpython-36.pyc
│ 0012_auto_20180618_2238.cpython-36.pyc
│ 0013_auto_20180619_0423.cpython-36.pyc
│ 0014_auto_20180619_0426.cpython-36.pyc
│ 0015_auto_20180619_0432.cpython-36.pyc
│ 0016_auto_20180619_0442.cpython-36.pyc
│ 0017_auto_20180619_0451.cpython-36.pyc
│ 0018_auto_20180626_1218.cpython-36.pyc
│ __init__.cpython-36.pyc
│
├───static
│ ├───css
│ │ bootstrap.css
│ │ custom_css.css
│ │
│ ├───images
│ │ 14.png
│ │ 3306.png
│ │ favicon.png
│ │ pbeach.jpg
│ │
│ └───js
│ bootstrap.js
│ parallax.min.js
│
├───templates
│ └───webpages
│ 404.html
│ fillform.html
│ good_resume.html
│ header.html
│ index.html
│ logout.html
│ read_docs.html
│ signin.html
│ signup.html
│ signupdata.html
│
└───__pycache__
admin.cpython-36.pyc
models.cpython-36.pyc
tests.cpython-36.pyc
urls.cpython-36.pyc
views.cpython-36.pyc
__init__.cpython-36.pyc
Feedback
Your feedback and suggestions on any part of this application is welcome. Please head over to Contributions to read the guidelines for making contributions. If you wish to drop suggestions via email, feel free to write to [email protected].
Running the web application
Once you are done verifying the folder structure, run this web application locally and begin exploring. You must have Anaconda distribution installed before proceeding. If you would like to get one. Head here.
Once you are good to go...
Type out the following after you cd
into the project directory :
Setting up the environment
Note : You can rename the myenv
identifier to any other name of your choice.
conda create --name myenv
conda activate myenv
pip install requirements
Running the Django server
python manage.py makemigrations
python manage.py migrate
python manage.py runserver
Knowing what's Running
Head over to http://localhost:8000 or http://127.0.0.1:8000 to find the development server serving the project's home page.
Finishing steps
Once you are done with exploration, you may shut down the server with :
- Ctrl+C
- Then
conda source deactivate
Debugging the application
- Chrome Dev Tools are a great fun in understanding what's taking time when rendering pages. Also, can help checking out cookies.
- The web application has
Debug=True
set. Please read Contributions on how to report errors. - Alternatively, you can use Django's default test runner using
python manage.py test
after including the tests.
Common troubleshoots
- Unable to Sign in or Sign up:
Make sure you followed each and every step above carefully without errors. Possible reasons:- The database might not be created.
- Cookies are disabled in browser.
Once step deploy
CV Generator
git clone https://github.com/Biswajee/CV-Generator.git