Your Next Intern (YNI) - API

Content

• Introduction
• Technologies
• APIs
• Quick Links
• Authors
• Reach Out

Introduction

YNI is a web application built to ease the process of seeking for internship positions by undergraduates in Nigerian Universities. It aims to bridge the gap between prospective interns and organizations looking to train/equip the next generation of talents.

With this API, organizations will be able to open or close their application windows, and they can also monitor the number of applicants on their profiles. Interns can apply to as many companies as possible, given that the application window of the company is open, or cancel their applications.

YNI-API is built with TypeScript, NestJs, and uses PostgreSQL as the RDBMS.

Back to content

Technology

This section lists the programming langauages, libraries, and frameworks used in the development of the application.

• Node.js
• TypeScript
• NestJs
• PostgreSQL
• Docker

Back to content

APIs

Please note that the endpoints here are not the complete documentation for the corresponding request and response types. A link to the complete documentation in postman will be provided in due time as development progresses.

• Authentication endpoints click here for code

  • POST /api/auth/companies/login - authentication of registered companies to login

  • POST /auth/interns/login - authentication of registered interns to login

  • POST /api/auth/companies - authentication of companies to register

  • POST /api/auth/interns - authentication of interns to register

• Companies endpoints - click here to see code

  • GET api/companies?pageNumber=1?pageSize=20 - Get all companies by page

  • POST /api/auth/companies - Add a new company

  • GET /api/companies/:id - Get a company.

  • PUT /api/companies/:id - update a company's information

  • DELETE /api/companies/:id - delete a company

• Interns endpoints - click here to see code

  • GET api/interns?pageNumber=1?pageSize=20 - Get all interns by page

  • POST /api/auth/interns - Add a new intern

  • GET /api/interns/:id - Get an intern.

  • PUT /api/interns/:id - update an intern's information

  • DELETE /api/interns/:id - delete an intern

  • POST /api/interns/:id/companies - Link a list of companies to an intern

Back to content

Quick links

Section	Link
Version One APIs	api/v1
Postman Documetation
Docker compose	docker

Authors

• Taiwo Babalola

Reach Out

Please reach out to me if you'd like to contribute to this project.

• Twitter
• Linkedin

Back to content