steveklabnik / assistant-api

A simple CRM for managing tattoo shops.

Artisan Tattoo Assistant - API

Prerequisites

NodeJS

Artisan Assistant API is an application built in Node JS using the Endpoints framework.

To run this app, please install Node.

Databases

This application is configured to be backed by a PostgreSQL database in production and SQLite in development. To use PostgreSQL locally, you will need to install it.

If you would like to change the database this application uses, update the knexfile. NOTE: You may also need to update the types in the migrations.

Knex CLI

This application uses the Knex command line tool to run migrations and seed the database. You will need to install it globally:

$ npm install knex -g

Up and Running

$ git clone [email protected]:artisan-tattoo/assistant-api.git
$ cd assistant-api
$ npm install
$ npm run db:setup
$ npm start

Navigate to http://localhost:8080.

Scripts

Artisan Assitant API uses npm scripts to automate tasks. The tasks available are:

• npm start: runs node index, starts a server at localhost:8080
• npm run db:setup: creates db, runs migrations and seeds
• npm run db:reset: drops db, then runs db:setup
• npm run lint: lints the javascript given options determined in .jshintrc