Skip to content

Labs-EU4/lambda-door-client

Repository files navigation

Build Status Netlify Status Coverage Status

Lambda Door v2.0

The frontend is deployed here: Lambda Door v2.0

Relevant Documents

PVD - Product Vision Document containing project planning and release canvas documents

Trello Board - Product and Task vision board

Whimsical - Wireframes for product design

Project Summary

Lambda Door is the one stop platform for Lambda Students and Alumni to find relevant information with respect to companies, interview processes, cultural fit and salary while on their job search.

We offer you a much simpler and friendlier approach by providing stream lined information about companies specific to your region, we also offer a one-on-one approach to make connections with previous job seekers that have interviewed or work(ed) with the companies you're interested in.

Team

Colin Toft Olamide Oredola Evans Ibok Rodrigo GraΓ§a
Frontend Architect Frontend Architect Frontend Architect Frontend Architect
Alexander Oguejiofor
Team Lead

Table of Content

  1. Tech used
  2. Starting the app
  3. Environment Variables
  4. Running the test
  5. How to contribute
  6. How to create a Request
  7. Attribution
  8. Backend
  9. LICENSE

Tech Used

HTML5, CSS3, ANT DESIGN, FORMIK, STYLED COMPONENTS, JAVASCRIPT, REACT, REDUX, JSONWEBTOKEN, FIREBASE, NODEMAILER, COVERALLS, SENTRY, TRAVIS CI, HEROKU, CRON SCHEDULER.

Starting the app

πŸ’¨

You need a basic knowledge of the following to be able to start up this project:

  1. Clone this project from your terminal
git clone https://github.com/Labs-EU4/lambda-door-client.git
  1. Move into the root folder and install dependencies
npm install [or] yarn install
  1. Start the app locally
npm start [or] yarn start

Environment Variables

πŸ”¬

Environment variables were used for the development and deployment, thus users must set up their own environment variables in an .env file.

Note: This file is ignored by git

REACT_APP_UPLOAD_PRESET=
REACT_APP_API_KEY=
REACT_APP_CLIENT_ID=
REACT_APP_CLIENT_SECRET=
REACT_APP_JWT_SECRET=
REACT_APP_REDIRECT_URI=
REACT_APP_BACKEND_URL=
REACT_APP_GOOGLE_API_KEY=

Running the test

πŸš€

Run this command in your terminal to startup tests:

npm test [or] yarn test

How to contribute

πŸ™Œ

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.

How to create a Request

Creating an 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.

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.

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.

Attribution

πŸ‘

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

Acknowledgment

  • Alex Emedeme - Engineering Manager
  • Lambda School - An immersive, online program to prepare you for a successful tech career

Backend

Documentation πŸ”Œ

See Lambda Door Backend v2.0 for details on the backend of our project.

Backend hosted at Lambda Door

LICENSE

This project possesses an MIT License.
Please see the LICENSE file for more details.

About

The one-stop portal for Lambda graduates looking for company information in the quest for a job.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages