Code Monkey home page Code Monkey logo

apiko-agro's Introduction

Apiko-Agro-App

Apiko agro app

Start

Make sure that you have last version of Node js and npm. Thеn run

npm install && npm run dev

Lint

npm run lint

Development process

Each task should be done on separate branches. Each branch started from task number, then follow name of branch t1-branch-name. After finishing task make pull request and notify about that, some of your colleagues for review your code.

Api Guide

(by models means organization, areas, landlords etc.

Route HTTP Verb Description
/api/v1/models/ GET Get list of models
/api/v1/models/ POST Crete model Item
/api/v1/models/:modelId GET Get model item
/api/v1/models/:modelId PUT Update model Item
/api/v1/models/:modelId DELETE Remove model item

Each route logic should be placed in server/controller/ folder. Each route should place permission checker(except, publict route)

 if (!hasPermissionTo(actions.EDIT_MODELS, user, res)) {
        return;
 }

Actions can be only:(except, special cases UPLOAD_FILES)

Name Operation
EDIT_MODELS POST, PUT, DELETE
VIEW_MODELS GET

In client in client/utils/api/urls.js files put only MODELS variable -> MODELS: '/api/v1/models',(except, special cases AMAZONS3: '/api/v1/amazonS3', )

Each controller should have documentation about each route, that is described. With @headers and @params.

/**
* Provide Api for Model
 
  Model list  GET /api/v1/models
  @header
         Authorization: Bearer {token}

  Model create  POST /api/v1/models
  @header
         Authorization: Bearer {token}
  @params
         param1 {string}
         param2 {boolean}
**/         

Made by Custom Software Development Company - Custom Software Development Company

apiko-agro's People

Watchers

James Cloos 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.