Skip to content

This backend server is to be used with the aniledev/petful-client and provides support for the First In First Out pet adoption client. This repo directory is organized by source files, files related to the /api/cats endpoint, the /api/dogs endpoint, and the /api/people endpoint.

Notifications You must be signed in to change notification settings

aniledev/petful-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Petful Server

A back-end server that returns information regarding pets to be adopted

GitHub language count GitHub top language GitHub code size in bytes GitHub repo size in bytes GitHub issues GitHub closed issues

Contents

Contents
  1. Application Summary
  2. API Documentation
  3. Scripts
  4. Built With
  5. Technical Aspects
  6. Deployment
  7. Acknowledgements
  8. Connect With Me

Application Summary

This backend server is to be used with the aniledev/petful-client and provides support for the First In First Out pet adoption client. This repo directory is organized by source files, files related to the /api/cats endpoint, the /api/dogs endpoint, and the /api/people endpoint.

Each endpoint uses the express.Router class to create modularized route handlers. Additionally, the routers make use of a service to easily preform actions using the queue data structure.

API Documentation

Full API documentation can be found on Postman. See the complete documentation for endpoint descriptions, example request snippets, and example response snippets in various formats.

Endpoints

Cats

GET /api/cats
DELETE /api/cats

Dogs

GET /api/dogs
DELETE /api/dogs

People

GET /api/people
POST /api/people
This endpoint requires a request body in the form of const { name } = req.body. DELETE /api/people

Status Codes

The API here returns the following status codes:

Status Code Description
200 Ok
201 Created
404 Bad Request
400 Not Found
500 Internal Server Error

Scripts

Start the application npm run start

Start nodemon for the application npm run dev

Run the tests npm run test

Built With

express git heroku javascript nodejs postman

Technical Aspects

Deployment

View the client repo here. The live api is hosted on Heroku. The live client is hosted with Vercel.

Acknowledgements

Connect With Me

🔭 I’m currently working on mastering data structures and complex algorithms.

🌱 I’m currently learning the fundamentals of Angular.

🤝 I’m looking for help with networking as a new dev in the community.

👨‍💻 All of my projects are available here

💬 Ask me about the ease of the PERN stack.

📫 The best way to reach me is by email: [email protected]

📄 Check out my resume of experiences

⚡ Fun fact Hiatus Kaiyote is my favorite band at the moment.

elina-mcgill

About

This backend server is to be used with the aniledev/petful-client and provides support for the First In First Out pet adoption client. This repo directory is organized by source files, files related to the /api/cats endpoint, the /api/dogs endpoint, and the /api/people endpoint.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published