Allay Documentation

You can find the deployed project on Heroku.

Contributors

Spencer McGuire	Aaron Pleitez	Nasra Aden	Matthew Weidner	William Chambers	Ignacio San Martin

Mandi Haase	Justine Gennaro	Shawn DelPercio	Edvin Saletovic	Alex Jenkins-Neary	Noah Franco

Heriberto Galvez Garcia	J. Caleb Spraul	Andrew Archie

Project Overview

Trello Board

Product Canvas

Welcome to Allay! We are a platform that aims to relieve stress for students by providing a dashboard where students and alumni can talk about their job seeking experience. We do this by allowing alumni to leave reviews, post about job interviews, and share salaries. Additionally, we aim to provide basic social networking between students and hired alumni.

Allay is a job portal for Lambda students and alumni to network and talk about their place of employment, hiring process, and salary range.

Key Features

• Onboarding using JWT for authentication
• Viewing and posting candid company reviews
• Viewing and posting informational interview reviews
• Viewing and editing your profile
• Visiting other reviewer's profiles

Tech Stack

Front end built using:

• React: Current industry standard for web applications, using React let us displaying large amounts of data effectively by implementing Components. It is also very scalable, perfect for large applications with huge growth potential.
• Redux: Centralizes our application's state and logic, easy to test/debug, works with any UI layer
• Chakra: Chakra UI is accessible and themeable component library. Simple to implement and build beautiful looking apps fast.
• Cypress: Fast, easy and reliable testing for anything that runs in a browser. Amazing UI tool for making setting up, writing, and running tests a breeze and easy to visualize.

Front end deployed to Heroku.

Back end built using:

• NodeJS
• Express
• Knex
• PostgreSQL
• Jest

APIs

Authentication API

To authenticate a new user, you must send the following to the back end.

Expects:

{
  "id": 1,
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "janedoe@email.com",
  "track_id": 1,
  "cohort": "FT 1",
  "password": "password"
}

Returns:

{
  "id": 1,
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "janedoe@email.com",
  "track_id": 1,
  "cohort": "FT 1",
  "reviews": []
}

Google Places API

Google places API for custom autocomplete input of city/state on interview and company review forms.

Clearit API

API for loading the company logos within the review card.

Usage: src={`//logo.clearbit.com/\${review.logo}`}

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. create a .env.local file that includes the following:

_ REACT_APP - Notates the enviroment for the database.

*    REACT_APP_databaseURL=https://labs21-allay-be.herokuapp.com/api

*    REACT_APP_NODE_ENV=
   <production> OR <development>

5️⃣ Content Licenses

Image Filename	Source / Creator	License
sign_in.png	Hanina Syed	MIT
register.png	Hanina Syed	MIT
interviewIcon.png	Elizabeth Lin	MIT
companyIcon.png	Elizabeth Lin	MIT
calendar-blue.png	Elizabeth Lin	MIT
calendar.png	Elizabeth Lin	MIT
check-square.svg	Elizabeth Lin	MIT
check.png	Elizabeth Lin	MIT
chevron-down.png	Elizabeth Lin	MIT
chevron-up.png	Elizabeth Lin	MIT
clock-blue.png	Elizabeth Lin	MIT
calendar-blue.png	Elizabeth Lin	MIT
clock.png	Elizabeth Lin	MIT
close.svg	Elizabeth Lin	MIT
difficulty-blue.png	Elizabeth Lin	MIT
Difficulty.png	Elizabeth Lin	MIT
dollar-sign-blue.png	Elizabeth Lin	MIT
dollar-sign.png	Elizabeth Lin	MIT
edit.png	Elizabeth Lin	MIT
flag.png	Elizabeth Lin	MIT
hamburger-blue.svg	Elizabeth Lin	MIT
hamburger.png	Elizabeth Lin	MIT
logout-gray.svg	Elizabeth Lin	MIT
logout.png	Elizabeth Lin	MIT
map-pin-blue.png	Elizabeth Lin	MIT
map-pin.png	Elizabeth Lin	MIT
minus-square.png	Elizabeth Lin	MIT
rounds-blue.png	Elizabeth Lin	MIT
Rounds.png	Elizabeth Lin	MIT
search-blue.png	Elizabeth Lin	MIT
search.png	Elizabeth Lin	MIT
star-blue.png	Elizabeth Lin	MIT
star-fill.png	Elizabeth Lin	MIT
star.png	Elizabeth Lin	MIT
thumbs-down-blue.png	Elizabeth Lin	MIT
thumbs-down.png	Elizabeth Lin	MIT
trash.png	Elizabeth Lin	MIT
user-check-blue.svg	Elizabeth Lin	MIT
user-check.png	Elizabeth Lin	MIT
user-logout.svg	Elizabeth Lin	MIT
user.png	Elizabeth Lin	MIT
user.svg	Elizabeth Lin	MIT
walk.png	Elizabeth Lin	MIT

Testing

We chose cypress for its flexibility and ease of use. Cypress has amazing UI tools that lets us see our tests running in real time, which relieves a lot of headaches.

Installation Instructions

To get the server running locally:

• Clone this repo

• npm i to install all required dependencies

• npm start to start the local server listening on localhost:3000

• For testing

• npm run cy:open to run testing with cypress

• npm run cypress:coverage to update code climate coverage report

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

ESLint && Prettier

• Configuration is already set up
• Team members most download prettier && ESLint as a VScode plugin
• for more information on changing the config files visit: https://lambda-school-labs.github.io/labs-guides/topics/eslint-prettier-setup/

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.