Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 2.27 KB

README.md

File metadata and controls

61 lines (46 loc) · 2.27 KB

Integrate Challenge

Overview

This project serves as the preliminary setup for the Integrate challenge, designed as part of the pre-interview process. Please ensure you follow the instructions detailed below to properly set up and verify the project's functionality before your interview commences.

Agenda

  • Intro: A brief introduction to the interview process and the goals for the day.
  • Challenge Overview: Explanation of the technical challenge, including its scope and expected outcomes.
  • Implementation: Discussion on the approach and technologies to be used in the challenge.
  • API Design Questions: Interactive session to explore the candidate's understanding and approach to API design principles.
  • Questions: An opportunity for candidates to ask any questions they may have about the challenge, the company, or future work.
  • Total Duration: ~70 minutes

Requirements

Local setup

  1. Navigate to the project directory.
  2. Install the dependencies:
    poetry install
    
  3. Run the application:
    poetry run uvicorn main:app --reload
    

(Alternatively) Local setup using Docker

  1. Clone the repository.
  2. Navigate to the project directory.
  3. Build the Docker container:
    docker build -t integration-challenge .
    
  4. Run the Docker container:
    docker run -p 8000:8000 integration-challenge
    

Verify the setup

Once the application is running, you can access it by navigating to http://localhost:8000/ in your web browser. This will display a list of examples fetched from the FastAPI application.

Go to http://localhost:8000/docs to access the autogenerated documentation, where you can test the API endpoints.

Recommended resources