Giter VIP home page Giter VIP logo

contentservice's Introduction

Content Service

The guide herein describes how to get the Content service up and running

Invoking locally

Before starting the server locally, ensure you have updated the app.contentservice.env file with proper configuration for the environment variables. There are two ways to start the server locally:

If you have npm and node (v >= 4.3) installed

Run the following commands to start a server:

  • npm install pm2 -g
  • npm install
  • npm start

Using Docker with Docker installed (v >= 1.12)

Run the following command to start the local server:

  • sh local/start.sh

Following any of the above steps should make the app accessible locally on the port specified in the app.contentservice.env file (8082) and visiting the url localhost:8082 should display a message Unsupported API version requested

You can now make requests via the application like this:

  • http://localhost:8082/v1/content/{postType}/{postCategory}/{postSlug}

For an example:

  • http://localhost:8082/v1/content/advice/Tires/this-is-a-test?country=id

Code Quality and Tests

Linting and regression tests have been setup for the project. To run linting:

  • npm run lint

To run regression tests:

  • npm run regression

All commands are to be run from a node environment

License

MIT

contentservice's People

Contributors

tobby-carmudi avatar thnico avatar sergekukharev avatar vacostag avatar tobbykuyinu 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.