Skip to content

Prettier and eslint configuration #11

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

Closed
wants to merge 14 commits into from
Closed
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
14 changes: 8 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ about: Report bug(s) encountered with the gallery api!
title: "[Bug]"
labels: bug
assignees: tjtanjin

---

**Bug Description:**
Provide a clear and concise description of the bug.

**Steps To Reproduce:**
Steps to reproduce the bug behavior:

1. Run the command '...'
2. Visit the API url '...'
3. See error
Expand All @@ -23,13 +23,15 @@ Describe the behavior that is expected to happen.
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser: [e.g. chrome, safari]

- OS: [e.g. iOS]
- Browser: [e.g. chrome, safari]

**Mobile (please complete the following information):**
- Device: [e.g. iPhone12]
- OS: [e.g. iOS8.1]
- Browser: [e.g. edge, firefox]

- Device: [e.g. iPhone12]
- OS: [e.g. iOS8.1]
- Browser: [e.g. edge, firefox]

**Additional Context:**
Add any other context about the problem here.
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Suggest an idea to improve the gallery api!
title: "[Feat]"
labels: enhancement
assignees: tjtanjin

---

**Is Your Feature Request Related to a Problem? Please describe:**
Expand Down
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Seek help with using the gallery api!
title: "[Help]"
labels: help wanted
assignees: tjtanjin

---

**Help Description:**
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
name: Task
about: Create a task to track work to be done for the gallery api (internal use)!
title: "[Task]"

---

**Task Description:**
Expand All @@ -15,6 +14,7 @@ State the expected deliverable(s) for this task (e.g. lint.yml file, configured
Add any other context about the task here.

**Reminders:**

- Assign task to a project (required)
- Assign task to a sprint (required)
- Assign task to a developer (optional)
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Please give a short overview/explanation on the approach taken to resolve the is

- [ ] The commit message follows our adopted [guidelines](https://www.conventionalcommits.org/en/v1.0.0/)
- [ ] Testing has been done for the change(s) added (for bug fixes/features)
- [ ] Relevant comments/docs have been added/updated (for bug fixes/features)
- [ ] Relevant comments/docs have been added/updated (for bug fixes/features)
12 changes: 12 additions & 0 deletions .github/workflows/format.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Prettier Workflow
run-name: ${{ github.actor }} running the job
on: [push]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install
run: npm install
- name: Run prettier check
run: npm run format:check
12 changes: 12 additions & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Lint Workflow
run-name: ${{ github.actor }} running the job
on: [push]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install
run: npm install
- name: Run ESLint
run: npm run lint
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"tabWidth": 2,
"useTabs": false
}
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@
</p>

## Table of Contents
* [Introduction](#introduction)
* [Features](#features)
* [Technologies](#technologies)
* [Quickstart](#quickstart)
* [Documentation](#documentation)
* [Team](#team)
* [Contributing](#contributing)
* [Support](#support)
* [Attributions](#attributions)

- [Introduction](#introduction)
- [Features](#features)
- [Technologies](#technologies)
- [Quickstart](#quickstart)
- [Documentation](#documentation)
- [Team](#team)
- [Contributing](#contributing)
- [Support](#support)
- [Attributions](#attributions)

### Introduction

Expand All @@ -27,7 +28,9 @@ Apart from a handful of background jobs, the Gallery API largely supports reques
For more information on what this project delivers, you may wish to check out the implementation section of the [**Developer Guide**](https://github.com/tjtanjin/react-chatbotify-gallery-api/blob/main/docs/DeveloperGuide.md).

### Technologies

Technologies used by React ChatBotify Gallery API are as below:

#### Done with:

<p align="center">
Expand All @@ -44,19 +47,23 @@ Typescript
</p>

#### Project Repository

- https://github.com/tjtanjin/react-chatbotify-gallery-api

### Team
* [Tan Jin](https://github.com/tjtanjin)

- [Tan Jin](https://github.com/tjtanjin)

// todo: the team will be expanded once members are confirmed

### Contributing

If you are looking to contribute to the project, you may find the [**Developer Guide**](https://github.com/tjtanjin/react-chatbotify-gallery-api/blob/main/docs/DeveloperGuide.md) useful.

In general, the forking workflow is encouraged and you may open a pull request with clear descriptions on the changes and what they are intended to do (enhancement, bug fixes etc). Alternatively, you may simply raise bugs or suggestions by opening an [**issue**](https://github.com/tjtanjin/react-chatbotify-gallery-api/issues) or raising it up on [**discord**](https://discord.gg/6R4DK4G5Zh).

Note: Templates have been created for pull requests and issues to guide you in the process.

### Support
If there are any questions pertaining to the application itself (usage or implementation wise), you may create an [**issue**](https://github.com/tjtanjin/react-chatbotify-gallery-api/issues), raise it up on [**discord**](https://discord.gg/6R4DK4G5Zh), or drop me an email at: **cjtanjin@gmail.com.**

If there are any questions pertaining to the application itself (usage or implementation wise), you may create an [**issue**](https://github.com/tjtanjin/react-chatbotify-gallery-api/issues), raise it up on [**discord**](https://discord.gg/6R4DK4G5Zh), or drop me an email at: **cjtanjin@gmail.com.**
11 changes: 2 additions & 9 deletions docker/docker-compose.dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ services:
volumes:
- redis-sessions-data-dev:/data
- ./config/redis/redis.dev.conf:/usr/local/etc/redis/redis.conf:ro
command: [ "redis-server", "/usr/local/etc/redis/redis.conf" ]
command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
healthcheck:
test: "exit 0"

Expand Down Expand Up @@ -131,13 +131,7 @@ services:
networks:
- core-network-dev
healthcheck:
test:
[
"CMD",
"curl",
"-f",
"http://localhost:9000/minio/health/live"
]
test: ["CMD", "curl", "-f", "http://localhost:9000/minio/health/live"]
interval: 30s
timeout: 20s
retries: 3
Expand All @@ -162,7 +156,6 @@ volumes:
minio-data-dev:
redis-sessions-data-dev:


networks:
nginx-network-dev:
driver: bridge
Expand Down
11 changes: 2 additions & 9 deletions docker/docker-compose.playground.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ services:
volumes:
- redis-sessions-data-playground:/data
- ./config/redis/redis.playground.conf:/usr/local/etc/redis/redis.conf:ro
command: [ "redis-server", "/usr/local/etc/redis/redis.conf" ]
command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
healthcheck:
test: "exit 0"

Expand Down Expand Up @@ -116,13 +116,7 @@ services:
networks:
- core-network-playground
healthcheck:
test:
[
"CMD",
"curl",
"-f",
"http://localhost:9000/minio/health/live"
]
test: ["CMD", "curl", "-f", "http://localhost:9000/minio/health/live"]
interval: 30s
timeout: 20s
retries: 3
Expand All @@ -147,7 +141,6 @@ volumes:
minio-data-playground:
redis-sessions-data-playground:


networks:
nginx-network-playground:
driver: bridge
Expand Down
11 changes: 2 additions & 9 deletions docker/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ services:
volumes:
- redis-sessions-data-prod:/data
- ./config/redis/redis.conf:/usr/local/etc/redis/redis.conf:ro
command: [ "redis-server", "/usr/local/etc/redis/redis.conf" ]
command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
healthcheck:
test: "exit 0"

Expand Down Expand Up @@ -115,13 +115,7 @@ services:
networks:
- core-network-prod
healthcheck:
test:
[
"CMD",
"curl",
"-f",
"http://localhost:9000/minio/health/live"
]
test: ["CMD", "curl", "-f", "http://localhost:9000/minio/health/live"]
interval: 30s
timeout: 20s
retries: 3
Expand All @@ -146,7 +140,6 @@ volumes:
minio-data-prod:
redis-sessions-data-prod:


networks:
nginx-network-prod:
driver: bridge
Expand Down
Loading