Git Product home page Git Product logo

guardrails-challenge's Introduction

Full Stack Engineer Challenge

This repository contains the challenge for full stack engineers.

Note: Please don't fork this repository, or create a pull request against it. Otherwise other applicants may take inspiration from it.

Devops Exercise

The backend and frontend exercises should be contained in one repository (monorepo), with the following directory layout:

├── api
├── dashboard
├── docker-compose.yml
└── README.md # documentation for this repo

The api and dashboard directories should have their own simple Dockerfile, so that they can be built and run individually.

The docker-compose.yml file should define both the api and dashboard as services, which will be automatically built and started upon calling docker-compose up. A container for a DB should be defined here as well.

Things you don’t have to worry about:

  • CI configuration / Deployment
  • Secret Management

Backend Exercise

The project should be made available in the api directory with meaningful commit messages. Use TypeScript + Node.js and any framework.

Implement a simple REST OR GraphQL API to CRUD a Security Scan Result (“Result”). The Result entity should have the following properties:

  • Id: any type of unique id
  • Status: "Queued" | "In Progress" | "Success" | "Failure"
  • RepositoryName: string
  • Findings: JSONB, see example
  • QueuedAt: timestamp
  • ScanningAt: timestamp
  • FinishedAt: timestamp

The Result entity should be stored in a database (of your choise).

Things you don’t have to worry about:

  • CI configuration / Deployment
  • APM
  • Authentication / Authorization / Auditing

Frontend Exercise

The project should be made available in the dashboard directory with meaningful commit messages. Use TypeScript + ReactJS and Semantic UI React.

Implement a simple dashboard that has three separated screens:

  1. First screen will only display a form that will allow to submit a scan result.

  2. Second screen will only display the list of security scan results. The columns of the list should be: repository name, scan status, findings (is the quantity of findings and should be displayed on a badge/label component, example here), and the according timestamp (i.e.: if Status is Queued, use QueuedAt).

  3. Third screen will only display the list of findings for a selected security scan (selected from the screen number 2) with the following 4 columns: RuleId, Description, Severity and Path name : line number.

The application is fairly simple, so you might not want to use any state management libraries – in this case please make sure your state management is clean, simple and easy to test. As well, we value the use of the latest features of react, but make sure you use them properly.

Things you don’t have to worry about:

  • Making it super pretty: The UI should be clean and properly aligned however it does not need any extraneous CSS and/or animations.
  • CI configuration / Deployment

Scoring

DevOps Points
Monorepo 0-1
Docker compose 0-2
README & Documentation 0-5
Backend Points
Framework 0-5
CRUD 0-5
Database 0-5
Frontend Points
ReactJS 0-5
Semantic UI 0-3
UI & Screens 0-5
State management 0-2
General Points
Commit messages 0-2
TypeScript 0-5
Project structure 0-5
Clean / clear code 0-5
Libraries 0-2
Comments 0-2
Linter / Prettifier 0-1
Unit tests 0-10

guardrails-challenge's People

Contributors

brandonwong91 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.