Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/huntermacias/qametricmonitor
https://github.com/huntermacias/qametricmonitor
costco-travel jenkins nextjs qa-automation qametrics splunk tfs
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/huntermacias/qametricmonitor
- Owner: huntermacias
- Created: 2024-11-29T21:57:03.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-07T05:32:35.000Z (29 days ago)
- Last Synced: 2025-01-07T06:26:13.917Z (29 days ago)
- Topics: costco-travel, jenkins, nextjs, qa-automation, qametrics, splunk, tfs
- Language: TypeScript
- Homepage:
- Size: 735 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Getting Started
Follow these instructions to set up and run `QAMetricMonitor` on your local machine for development and testing purposes.
### Prerequisites
Before you begin, ensure you have the following installed on your system:
[Docker](https://docs.docker.com/desktop/setup/install/windows-install/) :
is essential for containerizing your application, ensuring consistency across different environments.
[Node.js](https://nodejs.org/en/download) (v20 or higher) and npm:
Node.js is required to run your application, and npm serves as the package manager for handling dependencies.
## Installation
**Using Docker**
1. Clone the Repository
```sh
git clone https://github.com/huntermacias/QAMetricMonitor.git
cd QAMetricMontior
```
2. Build the Docker Image
```sh
docker build -t QAMetricMonitor .
```
3. Build with Docker compose (Optional)
- TODO : set this up when integrating DB
4. Run the Docker Container
```sh
docker run -p 3000:3000 QAMetricMonitor
```
**OR** Using Docker Compose:
```sh
docker-compose up
```
5. Access Application
- Open your browser and navigate to http://localhost:3000 to view the application.
### Local Setup without Docker
1. Clone the Repository
```sh
git clone https://github.com/huntermacias/QAMetricMonitor.git
cd QAMetricMontior
```
2. Install Dependencies
- Ensure you have the latest stable version of Node.js (v20 or higher).
```sh
npm install
```
3. Run the application
Start the development server
```sh
npm run dev
```
4. Access Application
- Open your browser and navigate to http://localhost:3000 to view the application.
## Contributing
1. Create a New Branch
```sh
git checkout -b feature/feature-name
```
2. Commit your changes
```sh
git add .
git commit -m "feature: description here"
```
3. Push to your fork
```sh
git push --set-upstream origin feature/feature-name
```
4. Create a pull request
- navigate to the repository on Github and submit a pull request detailing your changes.