Giter Club home page Giter Club logo

brodaoj56 / hng_internship_task Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 15.77 MB

This project is a web-based API built using Django, designed to provide specific information in JSON format. It serves as a solution for the HNG Internship Task, providing users with valuable data including the Slack name, current day of the week, current UTC time, track, and GitHub URLs.

Home Page: https://hngtask-po2z.onrender.com/api?slack_name=BrodaOJ&track=backend

License: MIT License

Python 97.72% PowerShell 0.06% Shell 0.02% CSS 0.59% JavaScript 0.81% HTML 0.80%
django python webapi

hng_internship_task's Introduction

HNG_INTERNSHIP_TASK

This project is a web-based API built using Django, designed to provide specific information in JSON format. It serves as a solution for the HNG Internship Task, providing users with valuable data including the Slack name, current day of the week, current UTC time, track, and GitHub URLs.

Features:

Retrieve user-specific information by providing Slack name and track as query parameters. Returns the current day of the week and UTC time with +/-2 validation. Includes GitHub URLs for both the file being executed and the full source code. Delivers responses in JSON format, making it easy to integrate with other systems and applications.

How to Use:

Make a GET request to the https://hngtask-po2z.onrender.com/api endpoint with the following query parameters:

slack_name: Your Slack name track: Your chosen track

Example : https://hngtask-po2z.onrender.com/api?slack_name=BrodaOJ&track=Backend Receive a JSON response containing the requested information, including current day and time, GitHub URLs, and more.

How to run on Local:

  1. Clone the repository:
git clone https://github.com/BrodaOJ56/HNG_INTERNSHIP_TASK.git
cd HNG_INTERNSHIP_TASK
  1. Create and activate a virtual environment (optional but recommended):
 python3 -m venv venv
source venv/bin/activate
  1. Install the dependencies:
pip install -r requirements.txt
  1. Run the Django development server:
python manage.py runserver

Access the API at http://127.0.0.1:8000/api with appropriate query parameters.

Contributing:

Contributions to this project are welcome! Feel free to fork the repository, make improvements, and submit pull requests.

License:

This project is licensed under the MIT License.

hng_internship_task's People

Contributors

brodaoj56 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.