https://github.com/teddyoweh/vmapi
A microservice-based system for managing a large-scale cloud computing infrastructure.
https://github.com/teddyoweh/vmapi
Last synced: 6 months ago
JSON representation
A microservice-based system for managing a large-scale cloud computing infrastructure.
- Host: GitHub
- URL: https://github.com/teddyoweh/vmapi
- Owner: teddyoweh
- Created: 2022-12-12T10:59:05.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-12T11:57:16.000Z (almost 3 years ago)
- Last Synced: 2025-03-24T00:24:01.803Z (6 months ago)
- Language: JavaScript
- Size: 232 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# VMAPI
A microservice-based system for managing a large-scale cloud computing infrastructure. This is a microservice that provides API endpoints for virtual machines, storage, and networking resources.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
Before you begin, make sure you have Node.js and npm installed on your system. You can check if you have these prerequisites installed by running the following commands in your terminal:
```sh
node --version
npm --version
```
If either of these commands return a version number, you have the prerequisites installed. If not, you can install them by following the instructions [here](https://nodejs.org/en/download/).
### Installing
To install the dependencies for this project, run the following command in your terminal from the root of the project:
```sh
npm install
```
This will install all of the dependencies listed in the `package.json` file.
### Running the service
To run the service, use the following command in your terminal from the root of the project:
```sh
npm start
```
This will start the service and begin listening for requests on port `3000`. You can specify a different port by setting the `PORT` environment variable when starting the service, like this:
## API
The API for this microservice provides the following endpoints:
### Virtual Machines
```sh
GET /api/v1/virtual-machines
```
This is the endpoint for all virtual machines functionalities
### Storage
```sh
GET /api/v1/storage
```
This endpoint returns information about the storage resources for the microservice.
### Networking
```sh
GET /api/v1/networking
```
This endpoint returns information about the networking resources for the microservice.
## Built With
* [Express](https://expressjs.com/) - The web framework used
## Author
* **Teddy Oweh**
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.