Giter VIP home page Giter VIP logo

english-for-kids_server's Introduction

English for kids (server)

Server for English for kids app

Built with

  • Javascript
  • Node.js
  • Express
  • PostgreSQL

Setup and Running

  • Install Node.js
  • Fork this repository: https://github.com/diman17/english-for-kids_server/
  • Clone your newly created repo: https://github.com/<%your_github_username%>/english-for-kids_server/
  • Go to folder english-for-kids_server
  • To install all dependencies use npm install
  • Create .env file where you need to specify the values of the following variables (database PostgeSQL):
    • PORT
    • DB_USER
    • DB_PASSWORD
    • DB_HOST
    • DB_PORT
    • DB_NAME
  • Start server npm start

Usage

Categories

Get categories

  • URL

    /categories

  • Method:

    GET

  • Headers:

    None

  • URL Params

    None

  • Query Params

    None

  • Data Params

    None

Get category by ID

  • URL

    /categories/:id

  • Method:

    GET

  • Headers:

    None

  • URL Params

    id=[integer]

  • Query Params

    None

  • Data Params

    None

Create category

  • URL

    /categories

  • Method:

    POST

  • Headers:

    'Content-Type': 'application/json'

  • URL Params

    None

  • Query Params

    None

  • Data Params

      {
    name: string
  }
Update category

  • URL

    /categories

  • Method:

    PUT

  • Headers:

    'Content-Type': 'application/json'

  • URL Params

    None

  • Query Params

    None

  • Data Params

      {
    id: number,
    name: string
  }
Delete category

  • URL

    /categories

  • Method:

    DELETE

  • Headers:

    'Content-Type': 'application/json'

  • URL Params

    None

  • Query Params

    None

  • Data Params

      {
    id: number
  }

Cards

Get cards

  • URL

    /cards

  • Method:

    GET

  • Headers:

    None

  • URL Params

    None

  • Query Params

    None

  • Data Params

    None

Get cards by category ID

  • URL

    /cards/:id

  • Method:

    GET

  • Headers:

    None

  • URL Params

    id=[integer]

  • Query Params

    None

  • Data Params

    None

Get card by ID

  • URL

    /cards/card/:id

  • Method:

    GET

  • Headers:

    None

  • URL Params

    id=[integer]

  • Query Params

    None

  • Data Params

    None

Create card

  • URL

    /cards

  • Method:

    POST

  • Headers:

    'Content-Type': 'application/json'

  • URL Params

    None

  • Query Params

    None

  • Data Params

      {
    image: string,
    audio: string,
    audioName: string,
    text: string,
    translate: string,
    categoryId: number
  }
Update card

  • URL

    /cards

  • Method:

    PUT

  • Headers:

    'Content-Type': 'application/json'

  • URL Params

    None

  • Query Params

    None

  • Data Params

      {
    id: number,
    image: string,
    audio: string,
    audioName: string,
    text: string,
    translate: string
  }
Delete card

  • URL

    /cards

  • Method:

    DELETE

  • Headers:

    'Content-Type': 'application/json'

  • URL Params

    None

  • Query Params

    None

  • Data Params

      {
    id: number
  }

english-for-kids_server's People

Contributors

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