https://github.com/triple-ade/pipeline
https://github.com/triple-ade/pipeline
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/triple-ade/pipeline
- Owner: TRIPLE-ADE
- Created: 2024-07-16T21:27:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T09:11:36.000Z (almost 2 years ago)
- Last Synced: 2025-01-11T21:32:56.806Z (over 1 year ago)
- Language: TypeScript
- Size: 401 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React + TypeScript + Vite
## Table of Contents
1. [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
2. [Contributing](#-contributing)
- [Contribution Guidelines](#contribution-guidelines)
- [Commit Cheat Sheet](#_commit-cheat-sheet)
## Getting Started
### Prerequisites
To run this project, you need the following installed:
- [Node 18.19](https://nodejs.org/) or later
- [NPM](https://www.npmjs.com/)
### Setup
1. **Clone the repository:**
```bash
git clone https://github.com/TRIPLE-ADE/pipeline-monitoring.git
```
2. **Install project dependencies:**
```bash
cd pipeline-monitoring
npm install
```
3. **Run the development server:**
```bash
npm run dev
# or
pnpm dev
# or
yarn dev
# or
bun dev
```
4. **Open your browser to view the result:**
- [http://localhost:5173/](http://localhost:5173/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
### Contribution Guidelines
1. **Clone the repository:**
```bash
git clone https://github.com/TRIPLE-ADE/pipeline-monitoring.git
```
2. **Create a new branch from the `dev` branch:**
```bash
git checkout -b Feat/{feature-name}
```
3. **Ensure your branch is up to date with the `dev` branch:**
```bash
git pull origin dev
```
4. **Make your changes, then add them:**
```bash
git add .
```
5. **Commit your changes with a descriptive message:**
```bash
git commit -m "your commit message"
```
6. **Ensure there are no conflicts:**
```bash
git pull origin dev
```
7. **Push your changes to the new branch:**
```bash
git push -u origin Feat/{feature-name}
```
8. **Create a pull request to the `dev` branch (not `main`):**
- Provide a detailed description of your pull request.
### _Commit Cheat Sheet_
| Type | Description |
| -------- | ----------------------------------------------------------------------------------------------------------- |
| feat | A new feature you're adding |
| fix | A bug fix |
| docs | Documentation only changes |
| style | Features and updates relating to styling |
| refactor | Code change that neither fixes a bug nor adds a feature |
| perf | Code change that improves performance |
| test | Adding missing tests or correcting existing tests |
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| chore | Other changes that don't modify source or test files |
| revert | Reverts a previous commit |
#### Sample Commit Messages
- `feat: Added plugin info endpoints` := `feat` is used here because the feature was non-existent before the commit.