Giter VIP home page Giter VIP logo

jobbot's Introduction

API DOCUMENTATION

This is a simple stateless microservice in Nodejs, with three major features -

  • Posts management
  • Comments management

Usage

To start the backend project; follow these steps:

Run cd server

Run npm i or yarn to install all the dependencies

Run sails lift to start the project

The backend is accessible via http://localhost:1337 by default

Additionally, you can run npm test to run the tests included in the project.

NOTE: Your server has to be running for the integration tests to complete. Also, it is recommended to have an internet connection because the database is hosted online.

Routes

This are the available endpoints at the backend:

Create Post

  • POST http://localhost:1337/post

    Example Request body:

        {
            title: 'title',
            description: 'description',
            author: 'author'
        }

Get Post By Id

  • GET http://localhost:1337/post/:id

    Example Request body:

        {  
        }

Search Post

  • POST http://localhost:1337/posts

    Example Request body:

        {
            size: 10,
            page: 1
        }

Create Comment

  • POST http://localhost:1337/comment

    Example Request body:

        {
            postId: 10,
            message: 1
        }

Search Comment

  • POST http://localhost:1337/comments

    Example Request body:

        {
            page: 1,
            size: 10
        }

FRONTEND DOCUMENTATION

Usage

To run this project follow these steps:

Run cd client

Run npm i or yarn to install all the dependencies

Then run npm start to start the project

The frontend is accessible via http://localhost:3000 by default

jobbot's People

Watchers

 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.