0.0.5 • Published 10 months ago

npm-try-soumya v0.0.5

Weekly downloads
-
License
MIT
Repository
-
Last release
10 months ago

npm-try-soumya

Trying to publish a npm package

About

This project uses Feathers. An open source web framework for building modern real-time applications.

Getting Started

Getting up and running is as easy as 1, 2, 3.

  1. Make sure you have NodeJS and npm installed.
  2. Install the package by the following command:

    npm install npm-try-soumya

    yarn add npm-try-soumya

  3. Usage of the Package and its configuration in app.ts or app.js:

    import auth from 'npm-try-soumya';
    
    // code of rest of app.ts
    app.configure(auth); 

    This will initialize the app instance of our package and the package can access then the global configuration available for the project.

  4. Features - Use the testMethodInNpm from AuthService.

     import {HookContext} from '@feathersjs/feathers';
     import {AuthService} from 'npm-try-soumya/dist/public_methods';
    
     const TestNPMPackage = () => async (context: HookContext) => {
    
        context.result = AuthService.testMethodInNpm('day', 'Tuesday');
    
        return context;
     };
    
     export default TestNPMPackage;

Testing

Simply run npm test and all your tests in the test/ directory will be run.

Scaffolding

Feathers has a powerful command line interface. Here are a few things it can do:

$ npm install -g @feathersjs/cli          # Install Feathers CLI

$ feathers generate service               # Generate a new Service
$ feathers generate hook                  # Generate a new Hook
$ feathers help                           # Show all commands

Help

For more information on all the things you can do with Feathers visit docs.feathersjs.com.