Code Monkey home page Code Monkey logo

book-club-server's Introduction

book-club-server

Node RESTful API for the book-club-client, built with express, mongoose and typescript.

Provides a server to organize your reading list.

Usage

Install dependencies:

yarn (or npm i)

Start the services:

yarn dev (or yarn build)

just make sure to have your package.json as it follows:

"scripts": {
    "dev": "nodemon src/server.ts",
    "build": "sucrase ./src -d ./dist --transforms typescript,imports"
  }

aswell as your nodemon file with:

"watch": ["src"],
    "ext": "ts",
    "execMap": {
        "ts": "sucrase-node src/server.ts"
    }

Project Structure

  • src/controllers follows the resource.controller name convention
  • src/schemas follows the resource.schemas name convention
  • src/routes.ts basic routing
  • src/server.ts listening to port (3333)

Commands

yarn build # Build production ready dist folder
yarn dev # Start server in dev mode
yarn lint # Lint project (eslint)

Endpoints

  • BookController
    • GET /books
    • POST /books
      • Payload
         {
            title: String,
            description: String,
            date: String,
            genre: String,
         }
    • DELETE /books/:id

book-club-server's People

Contributors

guiduck 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.