Personal API

A minimal, production-ready REST API built with Node.js and Express.

Project Description

This API provides identity and health-check endpoints in strict JSON formatting. Built to be exceptionally fast (<500ms responses), highly available, and easily deployed via PM2 and Nginx reverse proxy.

How to Run Locally

1. Clone the repository:

   git clone <your-repo-link>
   cd personal-api

2. Install dependencies:

   npm install

3. Start the development server:

   npm start

   The server will start locally on http://localhost:3000.

Endpoints and Responses

Method	Endpoint	Description	Expected 200 JSON Response
GET	/	Root Status	{"message": "API is running"}
GET	/health	API Health	{"message": "healthy"}
GET	/me	Identity	{"name": "Akwerigbe O. Okeoghene", "email": "akwerigbeoke@gmail.com", "github": "https://github.com/AkwerigbeO"}

Example cURL Tests

Ensure the server is running, then run these tests in your terminal:

# Test ROOT endpoint
curl -i http://localhost:3000/

# Test HEALTH endpoint
curl -i http://localhost:3000/health

# Test ME endpoint
curl -i http://localhost:3000/me

Live URL

Placeholder: http://your-production-url.com