Returns the server health status. The sentry status is also included in the response

Get server health status

The health status of  Clerk connection. The status can be OPERATIONAL, DEGRADED or FATAL.

* `OPERATIONAL` - OPERATIONAL
* `DEGRADED` - DEGRADED
* `FATAL` - FATAL

The health status of Clerk integration. The status can be OPERATIONAL or DOWN.

* `OPERATIONAL` - OPERATIONAL
* `DOWN` - DOWN

The status of the sentry integration. If False, the sentry is not initialized, possibly due to absense of environment variables, which is expected or misconfigured initialization.

* `OPERATIONAL` - OPERATIONAL
* `UNINITIALIZED` - UNINITIALIZED
* `FAILED` - FAILED

Letraz Internal Docs

Welcome to the internal documentation of Letraz. Albeit it's called internal, it's open to the public to go in alignment with our motto of transparency. This documentation is a work in progress and will be updated regularly as we develop new processes, APIs and workflows.

Introduction

Learn how to locally setup Letraz repositories for development purposes. This guide will help you set up the frontend, backend and utility repositories. And also as an added bonus the documentation repository and the admin panel.

Local Dev Setup

Guidelines for contributing to Letraz repositories. This document outlines the best practices and guidelines to be followed while contributing to the Letraz repositories. These guidelines are aimed primarily at the core team of Letraz as they have the required access in the Letraz's ecosystem to follow the guidelines mentioned here but these can be followed by anyone looking to contribute to the Letraz repositories.

Guidelines

Data Fetching Architecture with TanStack Query and Server Actions in Letraz's client side repository. This architecture provides a robust solution for data fetching in Next.js applications featuring seamless server-side and client-side data fetching, efficient caching and revalidation, type-safe API interactions, comprehensive error handling, feature-based organization, and built-in support for infinite scrolling.

PRD (Requirements) - Alpha

A comprehensive overview of the database schema of Letraz's systems. Letraz's database is designed to efficiently manage resume generation by storing user data, resume configurations, and job-related information. While this documentation is primarily for internal use, it is also publicly accessible for transparency, as Letraz is an open-source project. This document provides an overview of the schema, its structure, and the philosophy behind its design.

Database Schema

Data Fetching

Admin Panel

Live Frontend

Live Backend

Admin Dashboard

Support

Returns a sample error response that might occur if an operation fails. Note that the HTTP status would raise an error and that's a normal behavior.

Get sample error

Returns a sample error response that might occur if one or more operations fails from a bulk operation request. Note that the HTTP status would raise an error and that's a normal behavior.

Get sample error (bulk operations)

Returns all waitlist entries ordered by waiting number. The waiting number is the order in which the user joined the waitlist.

Get all waitlists

Send a POST request with the email of the user and optionally a ref string to add a new waitlist entry. Returns the newly created waitlist entry with the waiting number and created_at timestamp.

Add a new waitlist

Returns a user's user info by the user's id. If the user info is not found, a 404 error is returned.

Get user info

Send a PATCH request with the user's data to add or upsert a user info entry.
If the user info already exists, it will be updated. If the user info does not exist, it will be created.

Add a new user info

Returns the full job object as saved in the database by the job ID. If the job is not found, an error response is returned.

Get job by job ID

Gives a list of all resumes for the user. If no resumes are found, an empty list is returned.

Get all resume

Gives a resume for the user by produced id or gives base resume of the user if id is provided as `base`.

Get resume by id

Rearrange the order of sections in a resume by providing an array of section IDs in the desired order.

Rearrange resume sections

Gives all certifications for the Resume id or base if `base` is provided as resume id

Get all certifications

Adds a new certification to the user's resume as specified in the resume id.
If a `base` is provided as resume id, the certification is added to the base resume.

Create a new certification

Gives the certification of the resume for the user by produced id or gives base resume certification of the user if id is provided as `base`.

Get certification by id

Updates an existing certification of the user's resume as specified in the resume id.
If a `base` is provided as resume id, the certification is added to the base resume.

Update a certification

Delete an existing certification of the user's resume as specified in the resume id.
If a `base` is provided as resume id, the certification will be  deleted from to the base resume.

Delete a certification

Returns all education for the resume id of the user

Get all educations

Adds a new education to the user's resume as specified in the resume id.
If a base is provided as the resume_id, the education is added to the base resume.

Add a new education

Returns a user's education by the education's id.

Get education by id

Updates an existing education entry from the user's resume as specified in the resume id.
If a base is provided as the resume_id, the education is updated in the base resume.

Update an education

Deletes an education from the user's resume as specified in the resume id.

Delete an education

Get all experiences

Adds a new experience to the user's resume as specified in the resume id.
If a base resume id is provided, the experience is added to the base resume.

Create a new experience

Get experience by id

Updates an existing experience in the user's resume as specified in the resume id.
If a base is provided as the resume_id, the experience is updated in the base resume.

Update an experience

Deletes an experience from the user's resume as specified in the resume id.

Delete an experience

Gives all projects for the Resume id or base if `base`  is provided as resume id

Get all projects

Adds a new project to the user's resume as specified in the resume id.
If a `base` is provided as resume id, the Project is added to the base resume.

Create a new project

Updates an existing project of the user's resume as specified in the resume id.
If a `base` is provided as resume id, the Project is added to the base resume.

Update a project

Delete an existing project of the user's resume as specified in the resume id.
If a `base` is provided as resume id, the Project is added to the base resume.

Delete a project

Get all skills available in the database across users and resumes

Get all global skills

Get all global skill categories

Gives all skill for the Resume id or base if `base`  is provided as resume id

Get all skills of resume

Get all skill category for the resume

Adds a new Skill to the user's resume as specified in the resume id.
If a `base` is provided as resume id, the Skill is added to the base resume.

Add a new skill

Update an existing Skill-proficiency to the user's resume as specified in the resume id.
If a base resume id is provided, the Skill is updated for the base resume.

Update an existing skill

Deletes a skill-proficiency from the user's resume as specified in the resume id or base resume if `base ids provided as resume id`.

Get Started

Documents

Architecture

API References

Get server health status

Response