Applican

Applican is a full-service platform that helps people manage their job search. Its intuitive and easy-to-use interface helps job seekers stay organized while they land their dream job.

Table of Contents

1. Team
2. Getting Started
3. Requirements
4. Development
5. Contributing

Team

AppliCan is developed by four fullstack engineers.

• Anthony Ochmanowicz
• Christine Zhao
• Henry Han
• Jason Lushthaus

Getting Started

Follow these instructions if you want to fork the repo and start developing on your own. You do not need to follow these steps if you want to use our deployed build of Applican.

Prerequisites & Installing

1. Fork the repo and clone it to your development environment of choice.

2. To install Applican's dependencies, run the following command from the cloned repo's directory:

npm install

Configuration

You will need several environment variables and API Keys to run your own build of Applican. We use the NPM package dotenv for our local environment variables. You should make a .env file, placed in your clone's root directory, that looks like this:

AWS_ACCESS_KEY_ID=(AWS user  key with appropriate security policy to access S3 bucket)
AWS_SECRET_ACCESS_KEY=(Associated secret key)
EXPRESS_SESSION_SECRET=(a secure value to hash Express session) 
S3_BUCKET=(S3 bucket address for storing user uploads)
GOOGLE_CLIENT_ID=(Google oauth client ID) // Available from [Google](https://console.developers.google.com)
GOOGLE_CLIENT_SECRET = (Google oauth client secret) Available from [Google](https://console.developers.google.com)
RDS_DB_URL=(SQL database address)

Keep in mind that your database's environment variable requirements may be different. Applican is set up to use Sequelize with PostgreSQL on AWS RDS.

Built With

• React - Facebook's powerful JavaScript framework
• Redux - Efficient state manager for web applications
• Node.js - JavaScript runtime
• Express- Fantastic Node.js web server framework
• Passport - Library for various authentication strategies in Node.js
• PostgresSQL - Object-relational database
• Sequelize - Powerful ORM tool for SQL databases
• SASS - Extension of CSS
• Victory - Modular charting and data visualization library for React.js
• Webpack - Module bundler

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Contributors are welcome and will be clearly acknowledged.

License

This project is licensed under the MIT License - see the LICENSE.md file for details