Motivation

Easy Apply is a job search tool that improves upon the current job seeking process by allowing users to create a video introduction of themselves to express creativity and uniqueness of each user. Thereby allowing employers to easily digest applicants’ info via video format without shifting through heaps of resumes.

Getting Started

Prerequisites

• You will need python for the building backend.
• You will need npm and node for building the frontend.
• To deploy a local database server, this application is configured with postgresql. You will need postgresql.

Database

1. Start the postgresql server running on the default port:5432
2. Use the postgresql CLI tool to create a table under the postgres user.

psql -U postgres

3. Run the following to create the table. This table is used for the dummy API.

CREATE DATABASE dummyDB ( 
name VARCHAR ( 255 ) UNIQUE NOT NULL, 
id  serial PRIMARY KEY, 
date_created TIMESTAMP NOT NULL, date_modified TIMESTAMP );

Installation and deployment

1. Clone the repo.

git clone https://github.com/UTSCCSCC01/projectf21-team-anything-works.git easy-apply
cd easy-apply

2. Go to the backend directory and create a virtual environment.

cd backend && python3 -m venv .

3. Start the virtual environment. Note, depending on your setup the location of the activate file may differ.

source ./bin/activate

4. Install python dependencies into the virtual environment using the provided list.

pip install -r requirements.txt

5. Migrate the database

flask db init
flask db migrate -m "Initial migration."

6. Deploy the flask backend locally

python3 run.py

7. Go to the frontend directory and install all node dependencies

cd ../frontend && npm i 

8. Deploy the React Frontend locally

npm start

Configuration

Backend configuration is done in config.py. To connect your database, change the following variable appropriately:

SQLALCHEMY_DATABASE_URI = "postgresql://{user}:{password}@{HOSTNAME}:{PORT}/{tableName}"

To use the configuration as is, simply run the postgresql server with default settings. (As stated in the database section)

Contributing:

Please refer to each project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request