Giter Site home page Giter Site logo

omnidoc's Introduction

Installation

Install the dependencies and devDependencies and start the server. Import the database, attached to the repo, the name is "atm_omnidoc.sql" Change the environment variables of the .env file

PORT=3000 'default'
DB_NAME = 'nameDatabse'
DB_HOST = 'localhost',
DB_USER = 'user from database'
DB_PSW= 'password from database'

then run the following commands in the root folder

npm i
npm start

The documentation is generated in the enpoint {{url}}:port/api/doc || http://localhost:3000/api/doc

I personally use Postman to test the API, I leave the configuration file called "APIOmniPostman.json"

omnidoc's People

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.