Code Monkey home page Code Monkey logo

adoptfund-api's Introduction

Brief Overview

Build Your Own Backend is a node-express app connecting to a database through knex. It is the basis for an upcoming music app that will utilize the server built in this project. The postgres database consists of four main tables: Users, Comments, Favorites, and Access Tokens. The users table has relationships with all three listed tables. All endpoints are tested using Mocha Chai.

You can find the production link here

The RESTful endpoints are as follows:

Users

GET /api/v1/users

  • Fetch all users packaged as a JSON object

POST /api/v1/users

  • Subscribe as a new using providing an email and password

DELETE /api/v1/users/:id

  • Delete a user

PATCH /api/v1/users/:id

  • Modify an email address or password via the users' ID

Comments

GET /api/v1/comments

  • Fetch all comments packaged as a JSON object

POST /api/v1/comments

  • Post a comment providing a body

POST /api/v1/comments/:userId/:venueId

  • Post a comment that is exclusive to a user and a venue ID

DELETE /api/v1/comments/:id

  • Delete a comment while providing a user ID

PATCH /api/v1/comments/:id

  • Modify a comment providing a user ID

Favorites

GET /api/v1/favorites

  • Fetch all 'favorited' venues

POST /api/v1/favorites

  • Post a 'favorited' venue
  • Add a 'userId' query parameter to narrow down the 'favorited venue' by user

DELETE /api/v1/favorites/:id

  • Delete a 'favorited' venue providing a user ID

PATCH /api/v1/favorites/:id

  • Modify a 'favorited' venue providing a user ID

Access Tokens

GET /api/v1/donation

  • Fetch all access tokens

heroku config:set AWS_ACCESS_KEY_ID=xxx AWS_SECRET_ACCESS_KEY=yyy

adoptfund-api's People

Contributors

chelletuerk avatar jksmall0631 avatar mziccardi avatar noahpeden avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.