Skip to content

A Rails API, purpose-built to deliver alerts for nearby tattoo parlors and collections of tattoo images.

Notifications You must be signed in to change notification settings

margdaly/inklink-be

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BuiltWithLove

Get Linked for your next Ink!

InkLink is an app helping people find curated artists and local tattoo parlors that fit their tattoo style in their area. Don't know what style best fits you? Try our Discover Style feature to help best match you with the right style and the best artist to get you inked.

Experience InkLink wherever you are! Try us on the web or your mobile device! inklink.herokuapp.com

InkLink is the Consultancy group project from Turing School of Software and Design's mod three backend program. Read more: https://backend.turing.edu/module3/projects/consultancy/

Contributors


Angel Byun LinkedIn GitHub

Brandon Johnson LinkedIn GitHub

Brian Guthrie LinkedIn GitHub

Margaret Daly LinkedIn GitHub



Documentaion

Ink Link API Documentation

Schema

Artist{
name	string
email	string
password	string
password_confirmation	string
styles	[...]
pricing	string
}

Available Endpoints

GET 'api/v0/artists'

Parameters

Name Description
style, string(query) The style of the artist to filter by. Choices ["Watercolor", "American Traditional", "Geometric", "Script", "Black and Gray", "Realism", "Tribal", "Chicano", "Irezumi", "New School"]

Example

[
  {
    "name": "string",
    "email": "string",
    "password": "string",
    "password_confirmation": "string",
    "styles": [
      "string"
    ],
    "pricing": "string"
  }
]

Responses

Code Description
200 A list of artists

Example

[
  {
    "name": "string",
    "email": "string",
    "password": "string",
    "password_confirmation": "string",
    "styles": [
      "string"
    ],
    "pricing": "string"
  }
]

POST 'api/v0/artist'

Parameters

Name Description
artist details, required(body) example request body

Example

[
  {
    "name": "string",
    "email": "string",
    "password": "string",
    "password_confirmation": "string",
    "styles": [
      "string"
    ],
    "pricing": "string"
  },
  {
    "name": "string",
    "email": "string",
    "password": "string",
    "password_confirmation": "string",
    "styles": [
      "string"
    ],
    "pricing": "string"
  },
 ...
]

Responses

Code Description
201 The artist was created successfully.

Example

{
  "name": "string",
  "email": "string",
  "password": "string",
  "password_confirmation": "string",
  "styles": [
    "string"
  ],
  "pricing": "string"
}

GET 'api/v0/artist'

Parameters

Name Description
email, requiredstring(path) The email of the artist to retrieve.

Responses

Code Description
200 The artist.

Example

{
  "name": "string",
  "email": "string",
  "password": "string",
  "password_confirmation": "string",
  "styles": [
    "string"
  ],
  "pricing": "string"
}

PATCH 'api/v0/artist'

Parameters

Name Description
email, requiredstring(path) The email of the artist to update.

Responses

Code Description
200 The artist was updated successfully.

Example

{
  "name": "string",
  "email": "string",
  "password": "string",
  "password_confirmation": "string",
  "styles": [
    "string"
  ],
  "pricing": "string"
}

DELETE 'api/v0/artist'

Parameters

Name Description
email, requiredstring(path) The email of the artist to delete.

GET 'api/v0/search'

Parameters

Name Description
city, requiredstring The city to search for shops.

Responses

Code Description
200 A list of shops.

GET 'api/v0/discover'

Parameters

Name Description
email, requiredstring(path) The email of the artist to delete.

GET 'api/v0/search'

Parameters

Name Description
discover, requiredstring The style must be from ["Watercolor", "American Traditional", "Geometric", "Script", "Black and Gray", "Realism", "Tribal", "Chicano", "Irezumi", "New School"].

Responses

Code Description
200 A list of image urls.

Setup

Fork this repository. Clone your fork. From the command line, install gems and set up your DB:

bundle install
bundle update
rails db:{drop,create,migrate,seed}

Run the test suite with bundle exec rspec.

Built With

Backend

  • Ruby Rails PostgreSQL

Frontend

  • JavaScript Node.JS HTML Bootstrap JSON

Integrations/Deployment

  • Redis Heroku CircleCI Git GitHub

Planning and Workflow

  • Figma Canva Zoom Slack Markdown Notion