Giter Club home page Giter Club logo

inspect-my-cv's Introduction

Inspect my CV

Inspect my CV is application to improve your resume.


Front-end application

How to install

  1. Go to front-end directory: cd frontend
  2. Install Gulp (globally): sudo npm install -g gulp
  3. Install npm packages: npm install

How to start

  1. Go to front-end directory: cd frontend
  2. Start web-server gulp serve or just build project gulp build
  3. Application will be available by localhost:3000 address

How to test

We are using JavaScript validation tool ESLint. You can run ESLint using gulp test command.


Back-end application

How to install

  1. Create virtual environment in the inspect_my_cv_env folder: virtualenv inspect_my_cv_env
  2. Activate virtual environment: source inspect_my_cv_env/bin/activate
  3. Go to back-end directory: cd backend
  4. Install python requirements: pip install -r requirements.txt

How to start

  1. Go to back-end directory: cd backend
  2. Configure global environment variables: source .exports
  3. Activate virtual environment: source env/bin/activate
  4. Start python application: python app.py
  5. Application will be available by localhost:8080 address

API endpoints

Root URL - does nothing

  • URL: /api
  • METHOD: GET

Inspect CV - handles inspect-cv form

  • URL: /api/inspect_cv
  • METHOD: POST
  • PARAMS: JSON object {email, file, message, accept_terms}
  • RETURNS: JSON object {status}

Contact - handles contact-us form

  • URL: /api/contact
  • METHOD: POST
  • PARAMS: JSON object {name, email, phone, message}
  • RETURNS: JSON object {status}

Email templates

Contact-us form

Email for customer will be generated based on these templates:

  • contact_response/subject.html
  • contact_response/body.html

Email for site managers will be generated based on these templates:

  • contact_request/subject.html
  • contact_request/body.html

Inspect CV form

Email for customer will be generated based on these templates:

  • inspect_cv_request/subject.html
  • inspect_cv_request/body.html

Email for site managers will be generated based on these templates:

  • inspect_cv_response/subject.html
  • inspect_cv_response/body.html

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.