1.0.0 • Published 1 month ago

web-search-gateway v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
1 month ago
  1. Up & Running
  2. Understanding Project
  3. Best Practices

Up & Running

Prerequisites

NodeJS 14(recommended: 14.18.3) & JetBrains WebStorm | Vs Code

Installation & Building

$ git clone git@gitlab.trendyol.com:discovery/web/gateways/web-search-gateway.git
$ npm run bootstrap

Testing & Running

  1. Testing
$ npm run test
  1. Running
$ npm run start:dev
$ cd src/clients/search/v2 -> npm run start
$ cd src/clients/autoComplete/v3 -> npm run start

Troubleshooting

  • If you have config issue (check the .npmrc file), please try to run npm config set '@discovery:registry' 'https://gitlab.trendyol.com/api/v4/packages/npm/'

  • If you have problem with npm run bootstrap, please try to run npm install in root directory and please try to run these after npm install:

$ npm run install:clients
$ npm run build
$ npm run build:clients-dev
$ npm run build:assets
$ npm run copy:public
$ npm run copy:clients-css
  • If you have problem with running, please check your dynamic.json file in "dist/configuration" directory. If you don't have this file, please run npm run build in root directory.

If you still have problem, please open an issue.

Understanding Project

1. src/clients: React App

2. src/modules: Node App (BFF)

Best Practices

Lorem ipsum dolor sit amet.