项目作者: dougwt

项目描述 :
A Node.js+Express API server for curating project user stories.
高级语言: JavaScript
项目地址: git://github.com/dougwt/user-stories-api.git
创建时间: 2016-10-23T02:33:43Z
项目社区:https://github.com/dougwt/user-stories-api

开源协议:GNU General Public License v3.0

下载


user-stories-api

Build Status Coverage Status

A Node.js+Express API server for curating project user stories.

This source repo contains the NodeJS+Express API server powering MyUserStories.com.

Getting Started

Prerequisites

If you would like to run a local instance of this app in developer mode, the easiest method is using npm, the package manager included with Node.js.

  1. Install Node.js

  2. Install MongoDB

  3. Install the required JavaScript dependencies using npm:

    $ npm install

Running the app

To run the api server:

$ npm start

(Note: Requires mongodb to be running locally by default. MongoDB connection settings may be modified in app/config.js.)

Running the tests

To run the included tests:

$ npm test

(Note: Requires mongodb to be running locally by default. MongoDB connection settings may be modified in app/config.js.)

API Documentation

Auth

Users

Projects

Roles

Stories

†This protected route restricts access to resources owned by the authenticated user. Requests by non-administrators to resources owned by other users will result in a 401 Unauthorized error.

‡This restricted route requires authentication with Administrator privileges.

Software License

user-stories-api is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this code. If not, see http://www.gnu.org/licenses.

Acknowledgements

TBD