README.md

VBA helpers API

1. What is it

JSON API for https://vbahelpers.ru

And also a helpers storage

2. Where are the helpers stored

Excel file stores the helper's metadata and excel-to-json converts it into JSON file

VBA helpers are stored as plain text files in ./data/code folder

3. Links

• API landing page
• Frontend repo

4. API routes

• GET /api/helpers - get helpers data
• GET /api/helpers/search-by-title/:keyword - search helpers by title
• GET /api/helpers/search-by-category/:keyword - search helpers by category
• GET /api/helpers/search-by-keyword/:keyword - search helpers by keywords
• GET /api/helpers/search-by-name/:keyword - search helpers by name
• GET /api/categories - get helpers categories
• GET /api/categories/search/:keyword - search helpers category by its name
• GET /api/categories/search-by-keyword/:keyword - search helpers category by keywords

5. Install dependencies

git clone repo_url → cd ./repo-folder → npm ci

6. Build and run the app

cd ./repo-folder → npm run start