https://github.com/codewithgodstime/hng-stage-0
https://github.com/codewithgodstime/hng-stage-0
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/codewithgodstime/hng-stage-0
- Owner: codeWithGodstime
- Created: 2025-01-29T20:41:10.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-29T21:04:16.000Z (4 months ago)
- Last Synced: 2025-05-07T18:16:20.995Z (14 days ago)
- Language: Python
- Size: 1.95 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Documentation
## Project Overview
This project provides a simple API that returns the current date and time in UTC format, along with the developer's email and GitHub repository URL.
Check out [HNG PYTHON REPO HERE](https://hng.tech/hire/python-developers)
## Features
- Accepts **GET** requests.
- Returns a JSON response containing:
- Developer's email.
- Current UTC datetime in ISO 8601 format.
- GitHub repository URL.
- Provides an appropriate HTTP status code.
- Fast response time (< 500ms).
## API Endpoint
### **GET /api**
#### **Response (200 OK)**
```json
{
"email": "",
"current_datetime": "2025-01-30T09:30:00Z",
"github_url": "https://github.com/codeWithGodstime/hng-stage-0"
}
```
## Setup Instructions
### **1. Clone the Repository**
```bash
git clone https://github.com/codeWithGodstime/hng-stage-0
cd hng-stage-0
```
### **2. Install Dependencies**
If using Python and FastAPI:
```bash
pip install fastapi uvicorn
```
### **3. Run the Server**
For FastAPI:
```bash
uvicorn main:app --host 0.0.0.0 --port 8000
```
## Deployment
The API is deployed at:
```
https://productive-olga-stallion-4d01071f.koyeb.app/api
```
---
Developed by Godstime 🚀