Giter Site home page Giter Site logo

naics-api's Introduction

naics-api

Scraper and API built on top of data fed from NAICS.

Endpoints

Below endpoints are implemented as of now. Sample requests and responses can be figured out from the included Postman collection.

Method Path Description
GET /api/ For health check purposes
GET /api/codes List all codes from database
GET /api/refresh Triggers data refresh

Usage

First make sure you have Docker installed on your workstation. To run the project, just clone or download the project and run below command in project directory:

docker-compose up -d

Migrate the database to latest using below command:

docker-compose exec app ./node_modules/.bin/knex migrate:latest

Lastly, trigger a refresh to fetch data from NAICS website using below command:

curl -X POST "http://localhost:3000/api/refresh"

License

See LICENSE file.

naics-api's People

Contributors

swipevpz avatar vaibhavpandeyvpz avatar

Stargazers

avatar avatar

Watchers

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.