This project is an example of my skills in web development using TypeScript, JavaScript, Prisma, Express, and PostgreSQL. It's a RESTful API that implements various CRUD (Create, Read, Update, Delete) operations.
-
TypeScript: Enhances code robustness with static typing.
-
JavaScript: Adds dynamic functionalities, ensuring seamless web integration.
-
Prisma: Modern toolkit for efficient and type-safe database interactions in TypeScript and Node.js.
-
Express: Minimalistic Node.js framework for building RESTful APIs.
-
PostgreSQL: Chosen for scalability and reliability in the open-source relational database system.
- CRUD Operations: Complete implementation of Create, Read, Update, and Delete operations to manage data effectively.
- Type Safety: TypeScript is employed for enhanced code quality, reducing potential runtime errors.
- Database Integration: Seamless interaction with PostgreSQL using Prisma for efficient and secure data storage.
- Express Routing: Well-organized API routes with Express for clear and structured endpoint management.
Follow these simple steps to get the project up and running on your local machine:
-
Clone the Repository:
git clone https://github.com/meddhiaka/powerful-api-design.git
-
Install Dependencies:
cd powerful-api-design npm install
-
Configure Database:
- Set up your PostgreSQL database and update the connection details in the
.env
file.
- Set up your PostgreSQL database and update the connection details in the
-
Run the Application:
npm run dev
-
Explore the API: Visit
http://localhost:3000
in your browser or API testing tool to interact with the endpoints.
-
Test:
npm test
-
Development Mode:
npm run dev
-
Database Migration:
npm run migrate
-
Prisma Studio:
npm run studio
-
Build:
npm run build
This project is licensed under the MIT License - see the LICENSE file for details.