Code Monkey home page Code Monkey logo

notifications-exercise's Introduction

Notifications Exercise

Running Locally

  1. Clone project locally

  2. Install dependencies

npm  install

# or

yarn  install

# or

pnpm  install
  1. Start server locally
npm  run  serve

# or

yarn  serve

# or

pnpm  serve
  1. Start frontend locally
npm  run  dev

# or

yarn  dev

# or

pnpm  dev

Data API

This api uses json-server, see official documentation to learn more about it: https://github.com/typicode/json-server

All Notifications:

method: GET
route: http://localhost:3001/notifications

Unseen notifications:

method: GET
route: http://localhost:3001/notifications?seen=false

Paginated notifications:

  • Use _page and optionally _limit to paginate returned data.
method: GET
route: http://localhost:3001/notifications?_page={pageNumber}&_limit={limit}

Order of notifications:

  • Add _sort and _order (ascending order by default)
method: GET
route: http://localhost:3001/notifications?_sort={sortParam}&_order={asc | desc}

Mark notification as seen:

method: PATCH
route: http://localhost:3001/notifications/{id}

Mark all notifications as seen:

method: PUT
route: http://localhost:3001/notifications

Post new notification:

method: POST
body: {
   {
      body: string,
      user?: string
    },
}
route: http://localhost:3001/notifications

Response:

Headers:

  • In the Link header you'll get first, prev, next and last links.

  • X-Total header (total notifications count) and X-Unseen (total unseen notifications count) header are also included.

notifications-exercise's People

Contributors

danilo-timacum avatar

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.