/Express-Prisma-Boilerplate

Primary LanguageTypeScriptMIT LicenseMIT

Node.js TypeScript Prisma

Quick Start Node.js Project with TypeScript and Prisma

This repository provides a quick start template for setting up a Node.js project using TypeScript and Prisma as an ORM. It's designed to help you kickstart your development process with minimal configuration.

Prerequisites

Before you begin, ensure you have the following installed on your system:

  • Node.js (v14 or higher)
  • npm (Node Package Manager)
  • TypeScript

Installation

  1. Clone this repository to your local machine:

    git clone https://github.com/MahmoudSamir22/Express-Prisma-Boilerplate.git

  2. Navigate to the project directory:

cd NodeJs-Project-QuickStart
  1. Install the project dependencies:
npm install
  1. Copy the .env.example file and rename it to .env. Update the environment variables as needed:
cp .env.example .env

Upgrade Packages

To upgrade project dependencies, you can use the following command:

npm update

This will update all packages to their latest compatible versions.

Usage

1.Start the development server:

npm run dev

Project Structure

The project follows this directory structure:

  • src/: Contains the TypeScript source code files.
  • prisma/: Contains Prisma schema and migration files.
  • dist/: Output directory for compiled TypeScript files.

Contributing

Contributions are welcome! If you find any issues or want to enhance this template, feel free to submit a pull request.

License

This project is licensed under the MIT License.

Happy coding ^_^