Giter VIP home page Giter VIP logo

project-ong's Introduction

Server Base - Proyecto ONG

Envinroment setup

  1. Create database
  2. Copy .env.example to .env and fill with database credentials.

To install dependencies, run

npm install
  1. Migrations:
npx sequelize-cli db:migrate
  1. Seeders:
npx sequelize-cli db:seed:all

Start local server

npm start

logger

Winston Logger, it can be used throughout the API, creates a .log of each instance of logger created, 7 levels of log, error: 0, warn: 1, info: 2, http: 3, verbose: 4, debug: 5, silly: 6

eg:

const datesLog = require("../utils/logger")
.....
.....
    datesLog.info(`"message" : ${JSON.stringify(foo)}`);
    datesLog.info(`${JSON.stringify(foo)}`);
    datesLog.info(`"message"`);
    ............
    ............
    datesLog.warn(`"message" : ${JSON.stringify(foo)}`);
    datesLog.debug(`${JSON.stringify(foo)}`);
    datesLog.error(`"message"`);

http-status-codes

(Documentation extracted from: https://github.com/prettymuchbryce/http-status-codes/blob/master/README.md?plain=1)

Installation

npm install http-status-codes --save

Usage (express 4.x)

import {
	ReasonPhrases,
	StatusCodes,
	getReasonPhrase,
	getStatusCode,
} from 'http-status-codes';

eg 1: 

response
	.status(StatusCodes.OK)
	.send(ReasonPhrases.OK);

eg 2:
response
	.status(StatusCodes.INTERNAL_SERVER_ERROR)
	.send({
		error: getReasonPhrase(StatusCodes.INTERNAL_SERVER_ERROR)
	});

eg 3:
response
	.status(getStatusCode('Internal Server Error'))
	.send({
		error: 'Internal Server Error'
	});

Codes

Code Constant Reason Phrase
100 CONTINUE Continue
101 SWITCHING_PROTOCOLS Switching Protocols
102 PROCESSING Processing
200 OK OK
201 CREATED Created
202 ACCEPTED Accepted
203 NON_AUTHORITATIVE_INFORMATION Non Authoritative Information
204 NO_CONTENT No Content
205 RESET_CONTENT Reset Content
206 PARTIAL_CONTENT Partial Content
207 MULTI_STATUS Multi-Status
300 MULTIPLE_CHOICES Multiple Choices
301 MOVED_PERMANENTLY Moved Permanently
302 MOVED_TEMPORARILY Moved Temporarily
303 SEE_OTHER See Other
304 NOT_MODIFIED Not Modified
305 USE_PROXY Use Proxy
307 TEMPORARY_REDIRECT Temporary Redirect
308 PERMANENT_REDIRECT Permanent Redirect
400 BAD_REQUEST Bad Request
401 UNAUTHORIZED Unauthorized
402 PAYMENT_REQUIRED Payment Required
403 FORBIDDEN Forbidden
404 NOT_FOUND Not Found
405 METHOD_NOT_ALLOWED Method Not Allowed
406 NOT_ACCEPTABLE Not Acceptable
407 PROXY_AUTHENTICATION_REQUIRED Proxy Authentication Required
408 REQUEST_TIMEOUT Request Timeout
409 CONFLICT Conflict
410 GONE Gone
411 LENGTH_REQUIRED Length Required
412 PRECONDITION_FAILED Precondition Failed
413 REQUEST_TOO_LONG Request Entity Too Large
414 REQUEST_URI_TOO_LONG Request-URI Too Long
415 UNSUPPORTED_MEDIA_TYPE Unsupported Media Type
416 REQUESTED_RANGE_NOT_SATISFIABLE Requested Range Not Satisfiable
417 EXPECTATION_FAILED Expectation Failed
418 IM_A_TEAPOT I'm a teapot
419 INSUFFICIENT_SPACE_ON_RESOURCE Insufficient Space on Resource
420 METHOD_FAILURE Method Failure
421 MISDIRECTED_REQUEST Misdirected Request
422 UNPROCESSABLE_ENTITY Unprocessable Entity
423 LOCKED Locked
424 FAILED_DEPENDENCY Failed Dependency
428 PRECONDITION_REQUIRED Precondition Required
429 TOO_MANY_REQUESTS Too Many Requests
431 REQUEST_HEADER_FIELDS_TOO_LARGE Request Header Fields Too Large
451 UNAVAILABLE_FOR_LEGAL_REASONS Unavailable For Legal Reasons
500 INTERNAL_SERVER_ERROR Internal Server Error
501 NOT_IMPLEMENTED Not Implemented
502 BAD_GATEWAY Bad Gateway
503 SERVICE_UNAVAILABLE Service Unavailable
504 GATEWAY_TIMEOUT Gateway Timeout
505 HTTP_VERSION_NOT_SUPPORTED HTTP Version Not Supported
507 INSUFFICIENT_STORAGE Insufficient Storage
511 NETWORK_AUTHENTICATION_REQUIRED Network Authentication Required

Error Handler

try {
    ... code succes
    
  } catch (err) {
    next(err) ------> ( 'simple error handling returns error code and error stack ')
  }

Seeder Users

{  
      firstName: 'TestUserAdmin1',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 1,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserAdmin2',  
      lastName: 'Demo',  
      email: '[email protected]',    
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 1,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserAdmin3',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 1,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserAdmin4',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 1,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserAdmin5',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 1,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserAdmin6',  
      lastName: 'Demo',  
      email: '[email protected]',   
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 1,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserAdmin7',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 1,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserAdmin8',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 1,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },
    {
      firstName: 'TestUserAdmin9',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 1,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },
    {
      firstName: 'TestUserAdmin10',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 1,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserStandard1',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 2,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserStandard2',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 2,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserStandard3',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 2,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserStandard4',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 2,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserStandard5',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 2,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserStandard6',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 2,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserStandard7',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 2,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserStandard8',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 2,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserStandard9',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 2,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    },  
    {  
      firstName: 'TestUserStandard10',  
      lastName: 'Demo',  
      email: '[email protected]',  
      password: 'bugHunteRsNodeGroup81Alkemy123',  
      roleId: 2,  
      image: 'https://www.designevo.com/res/templates/thumb_small/colorful-hand-and-warm-community.png',  
      createdAt: new Date,  
      updatedAt: new Date  
    }

project-ong's People

Contributors

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