Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emmyaniedev/hng12-stage0-backend-task
https://github.com/emmyaniedev/hng12-stage0-backend-task
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/emmyaniedev/hng12-stage0-backend-task
- Owner: EmmyAnieDev
- Created: 2025-01-28T21:39:31.000Z (13 days ago)
- Default Branch: main
- Last Pushed: 2025-01-28T22:15:37.000Z (13 days ago)
- Last Synced: 2025-01-28T22:27:35.411Z (13 days ago)
- Language: Python
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.Md
Awesome Lists containing this project
README
# HNG Stage 0 Task - Basic Information API
This is a simple REST API built with Python Flask that returns basic information including an email address, current datetime, and GitHub repository URL.
## Description
This API provides a single endpoint that returns:
- The developer's email address
- Current datetime in ISO 8601 format (UTC timezone)
- GitHub repository URL containing the project codebase
## Setup Instructions
1. Clone the repository:
```bash
git clone https://github.com/EmmyAnieDev/hng12-stage0-backend-task
cd hng12-stage0-backend-task
```
2. Create a virtual environment and activate it:
```bash
python -m venv venv
source venv/bin/activate # On Windows, use: venv\Scripts\activate
```
3. Install dependencies:
```bash
pip install flask flask-cors
```
4. Run the application:
```bash
python app.py
```
The API will be available at `http://localhost:5001`
## API Documentation
### Endpoint
- URL: `GET /`
- Method: `GET`
### Response Format
```json
{
"email": "[email protected]",
"current_datetime": "2025-01-30T09:30:00Z",
"github_url": "https://github.com/EmmyAnieDev/hng12-stage0-backend-task"
}
```
### Example Usage
You can test the endpoint using curl:
```bash
curl http://localhost:5001/
```
Or in your browser: http://localhost:5001/
## Deployment
This API is deployed at: https://hng12-stage0-backend-task.onrender.com
## Related Links
- [Python Developers](https://hng.tech/hire/python-developers)
- [C# Developers](https://hng.tech/hire/csharp-developers)
- [Golang Developers](https://hng.tech/hire/golang-developers)
- [PHP Developers](https://hng.tech/hire/php-developers)
- [Java Developers](https://hng.tech/hire/java-developers)
- [NodeJS Developers](https://hng.tech/hire/nodejs-developers)