Skip to content

paulstgermain/vega-be

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vega

A proof-of-concept application dedicated to helping job seekers better manage, strategize, and more efficiently pursue the next step in their careers! Official rebuild coming soon!

View the demo video, or watch the Find-a-Job feature walkthrough

Table of Contents

Getting Started

Requirements

Before you begin, be sure you have the following installed:

  1. The most recent versions of node and npm
  2. pgAdmin 4

Installation Instructions

  1. Clone the repo:
git clone https://github.com/paulstgermain/vega-fe.git
  1. Install packages:
npm install
  1. Open pgAdmin 4 and create a new database
  2. Rename the .env.example file to .env
  3. Set up your .env file:
    1. Follow the vega-fe repo installation instructions
    1. Fill in the placeholders in the .env file's DATABASE_URL value (ex: postgresql://postgres:[PGADMIN_PASSWORD]@localhost:5432/[DATABASE_NAME]) (Remember to remove the brackets too: [])
    1. Copy your new app's Domain value into the .env file's AUTH0_ISSUER_BASE_URL value
    1. Copy your new API's API Audience value into the .env file's AUTH0_API_AUDIENCE value
  1. Run the migration file to establish database tables:
npm run migrate
  1. (Optional) To start with some dummy data in the database for demo purposes, replace all instances of both auth_id values in the db/seeds/01_jobs.js file with the user_ids of the demo users optionally created during the front-end repository's installation instructions, then run the seed file to fill the tables:
npm run seed
  1. Run the app:
npm start

Usage

Available scripts:

  1. start: Starts the server
  2. migrate: Creates your database's tables
  3. rollback: Rolls back your database's tables (WARNING: This deletes all tables, be sure you don't have data you don't want to lose in your database before running.)
  4. seed: Seeds your database with dummy data for demo purposes
  5. reset-db: Runs rollback, migrate, and seed commands in sequence. Useful for resetting a demo run (WARNING: Same as previous warning.)

**** (Use the app from the front end.)

  1. Create an account, or sign in with your existing Auth0 account to be taken to the Dashboard
  2. From the dashboard, click the pink, circular + button to add a new Job card to the board

Once you have any job card on the board, you can take any of the following actions:

  1. Use the Status dropdown to change the job's status quickly
  2. Click the To Job button to be taken to the job's original posting URL (If a proper URL was added)
  3. Click View Job Data to view all gathered info for that job
  4. From this view, click the Delete button to delete the job from your database, or...
  5. ... Edit the job's info, then click Save to save your changes

Contribution Guidelines

Pull requests are welcome. For major changes, please open an issue first. Before writing any code, please be sure to open a feature branch.

For example, feature/short_title_describing_feature for a new feature, or bugfix/short_title_describing_bugfix for bug fixes.

All PRs will be reviewed by the repository owner before they will be accepted and merged.

Screenshots

image Main page hero section

image Main Dashboard view

image Job card 'View Job Data' modal view example

About

A Node/Express back-end that enables safe user interaction with the Vega database.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors