Giter VIP home page Giter VIP logo

word-tokenizer's Introduction

Word Repetitions Tokenizer

simple express api which converts words from a url serving a txt file into tokens.

Setup

yarn

Start the server with nodemon(dev)

yarn dev

Start the server

yarn start

Run tests

// with coverage
yarn test

Run unit tests

// with coverage
yarn test:unit

// without coverage
yarn test unit

Run integration tests

// with coverage
yarn test:integration

// without coverage
yarn test integration

Run e2e tests

// with coverage
yarn test:e2e

// without coverage
yarn test e2e

Build & Run docker container

// to build - be sure you dont have a .env file changing the defualt port (3000)
yarn docker:build

// to run
yarn docker:run

Endpoints

? = optional

name body query description
GET / API end points
GET /tokenizer/tokenize-bible obj? return King James’ Bible tokenized as array
GET /tokenizer/tokenize-bible/?obj=1 obj? return King James’ Bible tokenized as object
POST /tokenizer/tokenize-me url obj? return custom link tokenized as array
POST /tokenizer/tokenize-me/?obj=1 url obj? return custom link tokenized as object

Note

the app has dotenv configured:

  • you can change the port by adding a .env in local dev environment with PORT (default is 3000)
  • same for tests, if tests fail for the long load time, set JEST_TIMEOUT (default is 40000 milliseconds)

License

Copyright © 2020 <stevorated (Shirel Garber)>

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.

word-tokenizer's People

Contributors

stevorated avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.