https://github.com/mauryiv/early-api-layout

https://github.com/mauryiv/early-api-layout

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mauryiv/early-api-layout
• Owner: MauryIV
• Created: 2024-03-08T00:15:13.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-03-10T23:52:19.000Z (11 months ago)
• Last Synced: 2024-10-15T05:23:36.463Z (3 months ago)
• Language: CSS
• Size: 35.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Early API Layout 



## Description

This has some basics for an API. Includes mutiple api pages and different routing pages that link together, as well as a custom 404 page.

[Check it out](https://early-api-layout.onrender.com/)

## Table of Contents

- [Title](#title)

- [Description](#description)

- [Badges](#badges)

- [Visuals](#visuals)

- [Installation](#installation)

- [Usage](#usage)

- [Tests](#tests)

- [Questions](#questions)

- [Roadmap](#roadmap)

- [Contributing](#contributing)

- [Authors and Acknowledgment](#acknowledgment)

- [License](#license)

- [Project Status](#status)



## Badges

![Maury Hughes IV](https://img.shields.io/badge/Maury%20Hughes%20IV-5A2BE2)

![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)



## Installation

User would need to install what is listed in package.json with an npm i entry in the integrated terminal.



## Usage

Good for reference in an api baseline. Lets user know when a GET, POST, and other request has been activated.



## Visuals

![Terminal info](https://github.com/MauryIV/early-api-layout/assets/146037880/9a601de7-c96e-4eed-b1f3-0c2b840abd67)



## Tests

I ran tests in Insomnia, if user is able to use Insomnia or something like it, would be good for running tests.



## Questions

If you have any questions about the contents. Please feel free to reach out!

Here is my [Github](https://github.com/MauryIV) as well as my email .



## Roadmap

NA



## Contributing

Open for any input to improve on or simplify the project. Please feel free to contact me.



## Authors and Acknowledgment

Most of the code (as mentioned in initial commit) is from the DU coding class.



## License

MIT License © 2024 Maury Hughes IV

Please refer to this link, [License: MIT](https://opensource.org/licenses/MIT) for more information.



## Project Status

Complete

[back to top](#title)