Jean Test Mobile

This repository contains instructions for the React Native hiring test, as well as a bootstrapped React Native app with which to start.

Your mission

Implement an invoicing app with React Native

Objectives

The goal is to leverage an existing REST HTTP API to build the prototype of an invoicing app.

This prototype allows users to perform simple actions around their invoices:

• List existing invoices with relevant details
• Create new invoices
• Manage existing invoices
  • Finalize invoices
  • Delete invoices

We do not expect the prototype to be feature-rich as we'll mainly focus on code quality, performance & user experience. We expect you to adopt standard coding practices & setup, including testing, as if you were working on a real application with other coworkers.

Feel free to use pre-installed dependencies or add new ones if you have a legitimate use of them.

Please take the time to identify advanced features that could be added in the future & write down tech improvements/ideas you could work on.

For each feature/tech improvement, we want to understand:

• What led you to think about this
• Why it would be useful
• What might be missing for you to implement it (API limitations, technical constraints)

Deliverable

• Create a private GitHub repository containing the source code of your application
• Invite the following GitHub users to it: @julienpinquie @soyoh @LucaGaspa @greeeg

What you're working with

Please note that we rely on asdf to manage Ruby/Node/Yarn versions. Feel free to use something else & have a look at .tool-versions if you run in any trouble.

Getting started

git clone [email protected]:pennylane-hq/jean_test_mobile.git

cd jean_test_mobile

bin/pull

# Make sure to add your token (sent by email)
cp .env.example .env

yarn start

yarn ios

Data model

The REST API contains 4 resources: customers, products, invoices & invoice lines.

Side notes:

• Invoices contain multiple invoice lines.
• Invoice lines are accessed via their invoice. To update them, use the relevant invoice API endpoints.
• Once the finalized field is set to true for invoices, no field may be modified except for paid.

The REST API base URL is https://jean-test-api.herokuapp.com/. Each API call must be authenticated using a X-SESSION header with the provided token.

An OpenAPI definition for this REST API is avaible here.

The invoices list endpoint supports a filter query param which can be used as described in our external API documentation.

API client

An API client based on openapi-client-axios is available through a React Context set up in src/api/index.tsx. The provider is mounted in src/App.tsx & the context can be consumed using the useApi hook from src/api/index.tsx.

const MyComponent = () => {
  const apiClient = useApi()

  useEffect(() => {
    apiClient.getInvoices().then(res => {
      // Do something...
    })
  }, [apiClient])

  return null
}