Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert "Use Bootstrap npm starter" #83

Merged
merged 1 commit into from
Jan 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions .browserslistrc

This file was deleted.

66 changes: 29 additions & 37 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,37 +1,29 @@
{
"env": {
"browser": true,
"es2021": true
},
"extends": ["airbnb-base", "prettier"],
"parserOptions": {
"ecmaVersion": 12,
"sourceType": "module"
},
"plugins": ["only-warn"],
"ignorePatterns": ["/node_modules", "/assets/css/dist"],
"rules": {
"no-console": [
"error",
{
"allow": ["warn", "error"]
}
],
"camelcase": "off",
"import/extensions": "off",
"object-shorthand": "off",
"no-underscore-dangle": [
2,
{
"allowAfterThis": true,
"allowAfterSuper": true
}
],
"no-plusplus": [
2,
{
"allowForLoopAfterthoughts": true
}
]
}
}
{
"env": {
"browser": true,
"es2021": true
},
"extends": [
"airbnb-base",
"prettier"
],
"parserOptions": {
"ecmaVersion": 12,
"sourceType": "module"
},
"plugins": ["only-warn"],
"ignorePatterns": ["/node_modules", "/external"],
"rules": {
"no-console": ["error", { "allow": ["warn", "error"] }],
"camelcase": "off",
"import/extensions": "off",
"object-shorthand": "off",
"no-underscore-dangle": [2, {
"allowAfterThis": true,
"allowAfterSuper": true
}],
"no-plusplus": [2, {
"allowForLoopAfterthoughts": true
}]
}
}
72 changes: 33 additions & 39 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,33 @@
---
name: Bug report
about: Create a report to help us improve
title: '[BUG] Bug-Title'
labels: Bug
assignees: ''
---

### Describe the bug

A clear and concise description of what the bug is.

### Screenshots

If applicable, add screenshots to help explain your problem.

### To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected behavior

A clear and concise description of what you expected to happen.

### Desktop (please complete the following information):

- **OS:** [e.g. iOS]
- **Browser:** [e.g. chrome, safari]
- **JS IDE:** [e.g. VS Code, Atom]
- (**Version:** [e.g. 22])

### Additional context

Add any other context about the problem here.
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] Bug-Title"
labels: Bug
assignees: ''

---

### Describe the bug
A clear and concise description of what the bug is.

### Screenshots
If applicable, add screenshots to help explain your problem.

### To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected behavior
A clear and concise description of what you expected to happen.

### Desktop (please complete the following information):
- **OS:** [e.g. iOS]
- **Browser:** [e.g. chrome, safari]
- **JS IDE:** [e.g. VS Code, Atom]
- (**Version:** [e.g. 22])

### Additional context
Add any other context about the problem here.
45 changes: 23 additions & 22 deletions .github/ISSUE_TEMPLATE/user-story.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
---
name: User Story
about: A normal user story as feature request.
title: ''
labels: ''
assignees: ''
---

As a ‹role›, I'd like to ‹feature short description› [ , in order to ‹value it adds›. ]

---

### :thought_balloon:   Hints & Thoughts

### :question:   Additional Questions to Answer / Consider

---

## :white_check_mark:   Conditions of satisfaction

- [ ] Should ‹testable condition that should be satisfied›
- [ ] Should ‹testable condition that should be satisfied›
---
name: User Story
about: A normal user story as feature request.
title: ''
labels: ''
assignees: ''

---

As a ‹role›, I'd like to ‹feature short description› [ , in order to ‹value it adds›. ]

---

### :thought_balloon:   Hints & Thoughts

### :question:   Additional Questions to Answer / Consider

---

## :white_check_mark:   Conditions of satisfaction

- [ ] Should ‹testable condition that should be satisfied›
- [ ] Should ‹testable condition that should be satisfied›
45 changes: 21 additions & 24 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@
!Please link the completed Issue to this Pull Request!

## Changes

**What does this PR change? What was the problem? What is the solution?**

_describe problem here_

- _enter change here_

## Screenshots

_If the frontend has been changed, please add a screenshot of before and after the changes have been made_

## Checklist before merge

**Developer's responsibilities**

- [ ] **Assign** one or two developers
- [ ] **Change code** if reviewer(s) has/have requested it
- [ ] **Pull request build** has passed
- [ ] **tested locally** (in at least chrome & firefox if frontend)
- [ ] updated the **documentation**
- [ ] added **tests** where necessary
!Please link the completed Issue to this Pull Request!

## Changes
**What does this PR change? What was the problem? What is the solution?**

*describe problem here*
- *enter change here*

## Screenshots
*If the frontend has been changed, please add a screenshot of before and after the changes have been made*


## Checklist before merge

**Developer's responsibilities**
* [ ] **Assign** one or two developers
* [ ] **Change code** if reviewer(s) has/have requested it
* [ ] **Pull request build** has passed
* [ ] **tested locally** (in at least chrome & firefox if frontend)
* [ ] updated the **documentation**
* [ ] added **tests** where necessary
3 changes: 2 additions & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
name: Build and Deploy
on:
push:
branches:
- 42-major-refactoring
# Allow manual triggering
workflow_dispatch:
jobs:
Expand All @@ -20,4 +22,3 @@ jobs:
with:
branch: gh-pages
folder: .
if: github.ref == 'refs/heads/main'
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
.idea/
node_modules
assets/css/dist/*
!assets/css/dist/.gitkeep
22 changes: 11 additions & 11 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"tabWidth": 4,
"bracketSpacing": true,
"endOfLine": "crlf",
"jsxSingleQuote": true,
"semi": false,
"singleQuote": true,
"trailingComma": "none",
"printWidth": 100,
"useTabs": false
}
{
"tabWidth": 4,
"bracketSpacing": true,
"endOfLine": "crlf",
"jsxSingleQuote": true,
"semi": false,
"singleQuote": true,
"trailingComma": "none",
"printWidth": 100,
"useTabs": false
}
4 changes: 0 additions & 4 deletions .stylelintignore

This file was deleted.

5 changes: 0 additions & 5 deletions .stylelintrc

This file was deleted.

64 changes: 27 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,27 @@
# RepositoryGuide

An application that helps with analyzing your team's GitHub repository

## Installation

1. Make sure you've installed node. If not download and install it from [here](https://nodejs.org/en/download/)
2. Clone the repository: `[email protected]:hpi-epic/repositoryguide.git` and go into the repository folder
3. Run `npm install` in the root of the repository
4. Run `npm start` to compile the scss and start a server
5. Open the home page in a browser (default address is `localhost:3000/views/home`)

## Configuration

1. Generate a personal access token for GitHub
using [these instructions](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)
2. On the settings page, download the config to have an empty version of a `config.json file`. Replace `"github_access_token": ""`
with `"github_access_token": "<your token>"`
3. Load the edited config into the application.

## Codestyle

To define a codestyle, we used Prettier and Eslint. Use `npm run prettier-<check|autofix>` or `npm run eslint-<check|autofix>` to apply these rules.

Alternatively, you can set these up for your IDE. For Webstorm follow the following tutorials:

- ESLint
- Follow the following steps from [this tutorial](https://www.jetbrains.com/help/webstorm/eslint.html)
- [Before you start](https://www.jetbrains.com/help/webstorm/eslint.html#ws_js_linters_eslint_before_you_start)
1&2
- [Configure ESLint automatically](https://www.jetbrains.com/help/webstorm/eslint.html#ws_js_eslint_automatic_configuration)
- [Recommended to run ESLint on save](https://www.jetbrains.com/help/webstorm/eslint.html#ws_eslint_configure_run_eslint_on_save)
- Prettier
- Follow the following steps from [this tutorial](https://www.jetbrains.com/help/webstorm/prettier.html)
- [Before you start](https://www.jetbrains.com/help/webstorm/prettier.html#prettier_before_you_start) 1,2 and 3
- [Configure Prettier 2,3, & 4](https://www.jetbrains.com/help/webstorm/prettier.html#ws_prettier_install)
- [Recommended to run Prettier on save](https://www.jetbrains.com/help/webstorm/prettier.html#ws_prettier_run_automatically_in_current_project)
# RepositoryGuide

An application that helps with analyzing your team's GitHub repository

## Installation

1. Clone the repository: ```[email protected]:hpi-epic/repositoryguide.git``` and go into the repository folder
2. Make sure you've installed node. If not download and install it from [here](https://nodejs.org/en/download/)
3. Run `npm install` in the root of the repository
4. generate a personal access token for GitHub using [these instructions](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)
5. Host the project on a local server, opening `index.html` directly won't work. The WebStorm IDE offers a local development server, or run one using `python3 -m http.server`.
6. Download the config to have an empty version of a `config.json file`. Replace ```"github_access_token": ""``` with ```"github_access_token": "<your token>"```
7. Load the edited config into the application.
8. The preparations are now done. Enjoy your metrics. :-)

## Codestyle
To follow the codestyle used in this repository you need Prettier and Eslint. After having setup the project you need to setup these tools. For Webstorm follow the following tutorials:
- ESLint
- Follow the following steps from [this tutorial](https://www.jetbrains.com/help/webstorm/eslint.html)
- [Before you start](https://www.jetbrains.com/help/webstorm/eslint.html#ws_js_linters_eslint_before_you_start) 1&2
- [Configure ESLint automatically](https://www.jetbrains.com/help/webstorm/eslint.html#ws_js_eslint_automatic_configuration)
- [Recommended to run ESLint on save](https://www.jetbrains.com/help/webstorm/eslint.html#ws_eslint_configure_run_eslint_on_save)
- Prettier
- Follow the following steps from [this tutorial](https://www.jetbrains.com/help/webstorm/prettier.html)
- [Before you start](https://www.jetbrains.com/help/webstorm/prettier.html#prettier_before_you_start) 1,2 and 3
- [Configure PRettier 2,3, & 4](https://www.jetbrains.com/help/webstorm/prettier.html#ws_prettier_install)
- [Recommended to run Prettier on save](https://www.jetbrains.com/help/webstorm/prettier.html#ws_prettier_run_automatically_in_current_project)
19 changes: 0 additions & 19 deletions assets/components/components.js

This file was deleted.

Loading