https://github.com/mcqua007/feathersjs-contact-api

https://github.com/mcqua007/feathersjs-contact-api

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mcqua007/feathersjs-contact-api
• Owner: mcqua007
• Created: 2019-12-01T23:59:43.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T12:22:14.000Z (over 2 years ago)
• Last Synced: 2024-12-29T16:37:20.367Z (5 months ago)
• Language: JavaScript
• Size: 1.65 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# contacts-api

> 

## About

This project uses [Feathers](http://feathersjs.com). 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](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.

2. Install your dependencies

    ```

    cd path/to/contacts-api

    npm install

    ```

3. Start your app

    ```

    npm start

    ```

## 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](http://docs.feathersjs.com).