Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jakemmarsh/monolist-music-api

node.js server and Express API for the now-defunct music app Monolist.
https://github.com/jakemmarsh/monolist-music-api

Last synced: 5 days ago
JSON representation

node.js server and Express API for the now-defunct music app Monolist.

Host: GitHub
URL: https://github.com/jakemmarsh/monolist-music-api
Owner: jakemmarsh
Created: 2015-01-02T18:10:00.000Z (about 10 years ago)
Default Branch: master
Last Pushed: 2016-11-15T02:15:50.000Z (about 8 years ago)
Last Synced: 2024-11-08T11:20:07.487Z (about 2 months ago)
Language: JavaScript
Homepage:
Size: 3.82 MB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        monolist-api [ ![Codeship Status for jakemmarsh/monolist-api](https://codeship.com/projects/ec14b0e0-5048-0133-827d-72fb7a1a2aa1/status?branch=master)](https://codeship.com/projects/107628) [![Dependency Status](https://david-dm.org/jakemmarsh/monolist-api.svg)](https://david-dm.org/jakemmarsh/monolist-api) [![devDependency Status](https://david-dm.org/jakemmarsh/monolist-api/dev-status.svg)](https://david-dm.org/jakemmarsh/monolist-api#info=devDependencies)

=============================================================================================================================================================================================

node.js server and Express API for the Monolist application. All endpoints can be seen in [`api/index.js`](https://github.com/jakemmarsh/monolist-api/blob/master/api/index.js).

---

#### To get up and running:

1. Clone this repo

2. Install node.js and NPM globally if you have not before. [Instructions here](http://blog.nodeknockout.com/post/65463770933/how-to-install-node-js-and-npm)

3. **Only necessary for development/testing:** install redis with `brew install redis` (using [Homebrew](http://brew.sh/) on OSX)

4. Run `npm install` from root project directory

5. Run `npm start` to simply start the server, or `npm run dev` to run Supervisor and Redis server

The API is served at `localhost:3000` by default, with all endpoints behind `localhost:3000/v1/`.

---

#### To run tests and generate coverage files:

1. Clone repo, install dependencies (Steps 1-3 above) **Note:** redis-server is necessary for running tests locally.

2. Run `npm test` to run all tests. Coverage files are output to `__coverage__/` directory.

3. Individual tests can be run with `node_modules/.bin/_mocha