Skip to content

Linked Dev is a platform that allows users (software developers) to create a public profile stating their skill set, years of experience, and a brief summary of them. Every internet user can access this profile, including recruiters and their potential employers.

Notifications You must be signed in to change notification settings

its-nedum/linkedev-web-service

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Linked Dev Web Service

Introduction

Linked Dev is a platform that allows users (software developers) to create a public profile stating their skill set, years of experience, and a brief summary of them. Every internet user can access this profile, including recruiters and their potential employers. The name was coined from LinkedIn (a social networking website for business people to communicate).

Live Link

Linked Dev - Server https://linkedev-api-service.onrender.com

Linked Dev - Client https://linked-dev.netlify.app/

Repository

  • Server Repo https://github.com/its-nedum/linkedev-web-service
  • Client Repo https://github.com/its-nedum/linkedev-web-client

Installation

To install Linked dev follow these steps

  1. Clone the repository from GitHub
$ git clone https://github.com/its-nedum/linkedev-web-service.git
  1. Navigate to the project directory
$ cd linkedev-web-service
  1. Install the required dependencies
$ npm install

Envronment Variables

Linked dev web service requires the following in your .env

  • PORT: Port number
  • MONGODB_URI: MongoDB connection uri
  • JWT_SECRET: JSON Web Tokens secret
  • JWT_EXPIRY: JSON Web Tokens expiry duration

Usage

To start the development server, run the following command

$ npm run dev

This command will compile the TypeScript code into JavaScript with the --watch flag and start up the server using nodemon

This will start the development server on http://localhost:{PORT}

API Routes

The table below shows the API endpoints and their functionalities on the web service.

HTTP VERB API ENDPOINT FUNCTIONALITY
POST /api/v1/users Create a user profile
GET /api/v1/users Fetch all users profile
GET /api/v1/user/:id Fetch a user profile
PATCH /api/v1/user/:id Update a user profile
DELETE /api/v1/user/:id Delete a user profile
POST /api/v1/register Create a user account
POST /api/v1/login Sign user into their account

Learn More About Technologies Used

To learn more please check out the following documentations

License

MIT

About

Linked Dev is a platform that allows users (software developers) to create a public profile stating their skill set, years of experience, and a brief summary of them. Every internet user can access this profile, including recruiters and their potential employers.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published