Portfolio API

This project is an API built using the Hono web application framework, Drizzle ORM and backed by a PostgreSQL database!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The Hono web application framework along with Zod makes for a great typesafe JavaScript API development experience. Drizzle ORM is a slim, performant, servless ready tool for database interface needs. It provides great support for PostgreSQL.

(back to top)

Built With

(back to top)

Data Model

Getting Started

Prerequisites

Installation

1. Clone the repo

   git clone https://github.com/andyfrith/portfolio-api.git

2. Install NPM packages

   npm install

3. Run the dev script

   npm run dev

(back to top)

Usage

For more examples, please refer to the imaginary Documentation

(back to top)

Roadmap

• Add improved README file.
• Deploy to Vercel.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

License

Distributed under the Unlicense License. See LICENSE.txt for more information.

(back to top)

Contact

Andy Frith - LinkedIn - [email protected]

Project Link: https://github.com/andyfrith/portfolio-api

(back to top)

Acknowledgments

• Syntax. Syntax is a Podcast about Web Development. Started by Wes and Scott in 2017, Syntax has published over 700 podcast episodes on full-stack web development.

(back to top)