https://github.com/andyfrith/portfolio-api
This project is an API built using the Hono web application framework, Drizzle ORM and backed by a PostgreSQL database.
https://github.com/andyfrith/portfolio-api
drizzle hono postgresql typescript
Last synced: about 2 months ago
JSON representation
This project is an API built using the Hono web application framework, Drizzle ORM and backed by a PostgreSQL database.
- Host: GitHub
- URL: https://github.com/andyfrith/portfolio-api
- Owner: andyfrith
- Created: 2024-12-12T15:23:23.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-17T18:18:03.000Z (over 1 year ago)
- Last Synced: 2025-02-06T22:30:06.936Z (over 1 year ago)
- Topics: drizzle, hono, postgresql, typescript
- Language: TypeScript
- Homepage:
- Size: 555 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Unlicense License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
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
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://afrith-portfolio-api.vercel.app/)
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.
### Built With
[![Typescript][Typescript]][Typescript-url]
[![Hono][Hono]][Hono-url]
[![Zod][Zod]][Zod-url]
[![Drizzle][Drizzle]][Drizzle-url]
[![PostgreSQL][PostgreSQL]][PostgreSQL-url]
## Data Model
![Data Model Screen Shot][data-model-screenshot]
## Getting Started
### Prerequisites
### Installation
1. Clone the repo
```sh
git clone https://github.com/andyfrith/portfolio-api.git
```
2. Install NPM packages
```sh
npm install
```
3. Run the dev script
```sh
npm run dev
```
## Usage
_For more examples, please refer to the imaginary [Documentation](https://example.com)_
## Roadmap
- [x] Add improved README file.
- [x] Deploy to Vercel.
See the [open issues](https://github.com/andyfrith/portfolio-api/issues) for a full list of proposed features (and known issues).
## 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:
## License
Distributed under the Unlicense License. See `LICENSE.txt` for more information.
## Contact
Andy Frith - [LinkedIn](https://www.linkedin.com/in/goodapplemedia/) - afrith.denver.usa@gmail.com
Project Link: [https://github.com/andyfrith/portfolio-api](https://www.linkedin.com/in/goodapplemedia/)
## Acknowledgments
- [Syntax.](https://www.youtube.com/@syntaxfm) 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.
[contributors-shield]: https://img.shields.io/github/contributors/andyfrith/password-strength-checker.svg?style=for-the-badge
[contributors-url]: https://github.com/andyfrith/password-strength-checker/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/andyfrith/password-strength-checker.svg?style=for-the-badge
[forks-url]: https://github.com/andyfrith/password-strength-checker/network/members
[stars-shield]: https://img.shields.io/github/stars/andyfrith/password-strength-checker.svg?style=for-the-badge
[stars-url]: https://github.com/andyfrith/password-strength-checker/stargazers
[issues-shield]: https://img.shields.io/github/issues/andyfrith/password-strength-checker.svg?style=for-the-badge
[issues-url]: https://github.com/andyfrith/password-strength-checker/issues
[license-shield]: https://img.shields.io/github/license/andyfrith/password-strength-checker.svg?style=for-the-badge
[license-url]: https://github.com/andyfrith/password-strength-checker/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/goodapplemedia/
[product-screenshot]: /screenshot.png
[data-model-screenshot]: /datamodel-v0.1.png
[Hono]: https://img.shields.io/badge/Hono-E36002?logo=hono&logoColor=fff
[Hono-url]: https://hono.dev/
[Zod]: https://img.shields.io/badge/-Zod-3E67B1?style=flat&logo=zod&logoColor=white
[Zod-url]: https://zod.dev/
[Drizzle]: https://img.shields.io/badge/Drizzle-C5F74F?logo=drizzle&logoColor=000&style=flat
[Drizzle-url]: https://orm.drizzle.team/
[PostgreSQL]: https://img.shields.io/badge/PostgreSQL-4169E1?logo=postgresql&logoColor=fff&style=flat
[PostgreSQL-url]: https://www.postgresql.org/
[Typescript]: https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=FFF&style=flat-square
[Typescript-url]: https://www.typescriptlang.org/