simdima / tldraid-api Goto Github PK

API server for tldrAId web app

Languages

• Description: Get available languages for man pages
• Method: GET
• URL: /languages

Example:

GET /languages

Utilities

• Description: Get list of utilities available for selected platform

• Method: GET

• URL: /utilities/{platform}

  Path	Type	Required?	Possible values
  platform	string	yes	android, common, linux, osx, windows

Example:

GET /utilities/osx

Utility

• Description: Get man page for selected utility
• Method: GET
• URL: /utility/{platform}/{language}/{utility}

  Path	Type	Required?	Possible values
  platform	string	yes	android, common, linux, osx, windows
  language	string	yes	see https://github.com/tldr-pages/tldr
  utility	string	yes	see https://github.com/tldr-pages/tldr

Example:

GET /utilities/common/en/ls

Option #1 The working instance of the API server can be found here

Option #2 Run it using Docker.

1. Download the latest release archive, extract the files to the directory of your choosing and navigate inside

2. Create an environment file and add a port you want this application to run on:

# Change port if needed
touch .env && echo "PORT=5510" > .env

3. Build a Docker image (change EXPOSE variable if needed)

docker build -t tldraid-api:{tag} .

4. Spin up a Docker container (change ports according to your setup)

docker run --name tldraid-api -p 5510:5510 -d tldraid-api:{tag}

Clone the repository, navigate inside and run:

# set app port (will default to port 3000 if not set)
touch .env && echo "PORT=XXXX" > .env

# install dependencies
yarn

# download the latest versions of manpages from tldr repo
yarn download:assets

yarn start # or yarn start:dev to start in watch mode

This project utilizes the following community-maintained projects:

• tldr-pages

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Dmitri Sim