node-search-engine

Search Engine using Node and Elasticsearch

Getting started

# Clone the project
git clone [email protected]:pranavpr/node-search-engine.git
cd node-search-engine

# Install dependencies
npm install

# or if you're using Yarn
yarn

If you don't use Yarn you can just replace yarn with npm in the commands that follow.

Then you can begin development:

yarn dev

This will launch a nodemon process for automatic server restarts when your code changes.

Testing

Testing is powered by Jest. This project also uses supertest for demonstrating a simple routing smoke test suite. Feel free to remove supertest entirely if you don't wish to use it.

Start the test runner in watch mode with:

yarn test

You can also generate coverage with:

yarn test --coverage

Environmental variables

The project uses dotenv for setting environmental variables. Check .env and update env vars as you see fit.

Building

yarn run build

will compile your src into /dist for production deployment.

License

MIT License. See the LICENSE file.