/talentuzz-api

REST API for Talentuzz. Built with NestJS, Prisma, Postgres, Docker.

Primary LanguageTypeScript

Talentuzz API

Talentuzz API is a project developed with NestJS, TypeScript, PostgreSQL, Prisma, Swagger, and Docker. It serves as the backend for the Talentuzz hiring platform, providing APIs for managing organizations, jobs, and user authentication.

Getting Started  ❖  Overview  ❖  Features  ❖  Stack  ❖  Deploy ↗︎  ❖  API Docs ↗︎

✌ Please don't forget to leave a star

See more projects on my profile - @henriqgoncalvs

🛠️ Stack

  • NestJS with TypeScript - A progressive Node.js framework for building efficient and scalable server-side applications.
  • PostgreSQL - A powerful, open-source relational database management system.
  • Prisma - A modern database toolkit for TypeScript and Node.js that helps you write database queries in a type-safe and efficient way.
  • Swagger - An open-source toolset for designing, building, and documenting RESTful APIs.
  • Docker - A platform for developing, shipping, and running applications using containerization.

✨ Features

  • User authentication and authorization
  • Organization management
  • Job management
  • API documentation with Swagger

🚀 Getting Started

Project setup:

  1. Clone or fork the repository:
git@github.com:hnqg/talentuzz-api.git
  1. Install the dependencies:
npm install

Environment variables:

  1. Create a .env file in the root directory and provide the necessary environment variables. You can use the .env.example file as a template.

Database setup:

  1. Set up a PostgreSQL database and update the database connection details in the .env file.

Run the project:

  1. Start the application:
npm run start:dev

The Talentuzz API will be running at http://localhost:3000.

😊 Contributing

☁ Deploy

  • Render.com: Use a platform as Render.com for easy deploy (I'm not sponsored by Render.com, I just like it).
  • Docker: Use Docker to containerize the application and deploy it to your preferred hosting platform.

🐲 Created by Henrique Gonçalves. You can find me at Instagram Badge Linkedin Badge