readme.md

groovebase-api

groovebase music app API, a vinyl collection manager and "Goodreads for music"

About

This project uses Feathers. An open source framework for building APIs and real-time applications.

Check out the React Native frontend here

Getting Started

1. Make sure you have NodeJS and npm installed.

2. Install your dependencies

   cd path/to/groovebase-api
   npm install
   

3. Start your app

   npm run compile # Compile TypeScript source
   npm run migrate # Run migrations to set up the database
   npm start
   

Testing

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

Scaffolding

This app comes with a powerful command line interface for Feathers. Here are a few things it can do:

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

Help

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