whiterqbbit/tictactrip_test

Justife For All - Text Justifier API

Welcome to Justife For All, the one and only API for justifying all your text. Throw plain text, receive justification !

API Endpoints

The base URL for all API endpoints is https://tictactrip.whiterqbbit.io/

1. Root Endpoint (/):

   A GET request to this endpoint returns a nice emoji. Not much about it.

2. Token Endpoint (/token):

   A POST request with a JSON body containing an email field to this endpoint will return a token. Doc for this endpoint here.

3. Justify Endpoint (/justify):

   A POST request with a body of ContentType text/plain will returns justified text. Doc for this endpoint here.

Installation

To set up and run this project locally, follow the below steps:

1. Clone the repository to your local machine:

   git clone https://github.com/whiterqbbit/tictactrip_test

2. Fill in the environment variables in .env file:

   JWT_SECRET=your_secret
   DATABASE_URL=your_database_url

3. Use Docker to run the project:

   docker-compose up

4. Setup your pre-commit hook if needed in .git/hooks/pre-commit:

   #!/bin/sh
   export PATH="path/to/pnpm:$PATH"
   export PATH="path/to/node:$PATH"
   pnpm pre-commit