OVH Expiration Fetcher

An Express server which fetches expiration date from the OVH API.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Example Output With Explanation
2. Getting Started
   • Prerequisites
   • Running the Server
   • Usage
3. Contributing
4. License
5. Contact

About The Project

OVH Data Fetcher is a Node.js Express server designed to fetch the expiration information from a chosen VPS service from the OVH API. It provides an endpoint to retrieve the fetched data and also saves the data locally in a JSON format.

(back to top)

Built With

• NodeJS
• Express
• OVH

(back to top)

Example Output With Explanation

• The fetched expiration date, which is June 1, 2024.
• The local date and time when the data was fetched is April 17, 2024, at 04:21:57 AM.

(back to top)

Getting Started

To get the server up and running follow these simple steps.

Prerequisites

• Node.js installed on your machine
• OVH API credentials in your environment variables (OVH_ENDPOINT, APP_KEY, APP_SECRET, CONSUMER_KEY)
• A VPS service name set in your environment variables

Running The Server

1. Clone the repo - git clone https://github.com/Arad119/OVH-Expiration-Fetcher.git
2. Go into the directory and install NPM packages - npm install
3. Set up environment variables by creating a .env file in the root directory and adding your OVH credentials and VPS service name

OVH_ENDPOINT=your_ovh_endpoint
APP_KEY=your_app_key
APP_SECRET=your_app_secret
CONSUMER_KEY=your_consumer_key
VPS_NAME=your_vps_service_name

4. Run the server - npm start

Usage

Once the server is running, you can access the OVH data by sending a GET request to the root endpoint (/). The server fetches the data from the OVH API when it starts and then at a regular interval (24 hours by default) to keep it updated.

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Twitter @Arad119 - Email [email protected]

Project Link: https://github.com/Arad119/OVH-Expiration-Fetcher

(back to top)