Project Starter Kit: Neon Postgres Database + ExpressJs + TypeScript and TypeORM + CLI Tool

#devchallenge #neonchallenge #postgres #database

This is a submission for the Neon Open Source Starter Kit Challenge : Ultimate Starter Kit

My Kit

This starter kit implements major CRUD Operations that you can leverage for quickly scaffolding your own models and database operations for any Back-end Project you're undertaking. From entity definition (Models), relationship, database configuration and initial setup with Jest - just write your test and hit npm run test.

Whether you're a beginner looking for a quick start to work with the powerful combination of TypeScript + TypeORM + Neon Postgres + ExpressJs or an experienced developer, this is the Swiss knife of all starter kits.

Link to Kit on GitHub

https://github.com/Cre8steveDev/Neon_Postgres_Express_TypeScript_TypeORM_Starter_Kit/
You can find the Kit here on GitHub with a detailed guide on how to use it. The Code base is properly documented to also serve as a reference guide to boost your productivity.

CLI Tool (Npm Package)

https://www.npmjs.com/package/neon-express-typeorm
If you prefer to use the command line to quickly bootstrap your project, choosing the full kit or a basic setup, then you're welcome to use the cli tool.

npm i -g neon-express-typeorm

My Journey in Setting Up This Kit

I've recently taken up writing guides/reusable code snippets for the tech stack and tools I use and explore. I've found this to be quite helpful in improving the time spent in finding a reference for future projects that implement/use the same features/tools.

It was fun creating this Starter Kit for ExpressJS + TypeScript + to explore the features offered by the Neon team's PostgreSQL Database using TypeORM. This meant, I had to spend a lot of time researching on the TypeORM documentation to ensure I follow best practice in delivering this kit to the Open Source community.

The phrase "Versioning your database like Code" has stuck in my mind since I read up on the features offered by Neon for their Postgres Database. Phew! Now, the interns won't push breaking changes to the Production Database haha. Just kidding.

You can find a Code documentation/debugging tips to see some errors I encountered in the early stage of setting up the Kit and the solutions I researched to fix it - in case you encounter same.

Otherwise, the starter kit has been tested and ready for you to craft magic! Future update, an interactive command line tool to customize the kit based on your project needs.

Till then, Happy Coding!