Skip to content

Commit 26ddd26

Browse files
mittalyashumittalyashu
committedJul 20, 2021
add prettier && husky
1 parent f769e23 commit 26ddd26

26 files changed

+86
-51
lines changed
 

‎.github/dependabot.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
version: 2
22
updates:
3-
- package-ecosystem: "npm"
4-
directory: "/"
3+
- package-ecosystem: 'npm'
4+
directory: '/'
55
schedule:
6-
interval: "daily"
6+
interval: 'daily'
77
assignees:
8-
- "mittalyashu"
8+
- 'mittalyashu'
99
open-pull-requests-limit: 10

‎.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ jobs:
1414
- uses: JustinBeckwith/linkinator-action@v1
1515
name: Lint links
1616
with:
17-
paths: "**/*"
17+
paths: '**/*'
1818
recurse: true
1919
directoryListing: true

‎.husky/pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
. "$(dirname "$0")/_/husky.sh"
3+
4+
yarn prettier

‎.prettierrc

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"semi": false,
3+
"singleQuote": true,
4+
"printWidth": 120,
5+
"arrowParens": "always",
6+
"trailingComma": "es5",
7+
"bracketSpacing": true
8+
}

‎api/glossary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ title: Glossary
55
You can refer to this glossary page to understand the termonology used in the APIs.
66

77
| Keyword | Description |
8-
| --- | --- |
8+
| ------- | ----------- |

‎api/v1/auth/login.md

-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ https://yourdomain.com/api/v1/auth/login
2929
}
3030
```
3131

32-
3332
## Response
3433

3534
| Fields | Type | Description |

‎data/partners.yml

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
- id: 1
2-
title: "CodeCarrot"
3-
link: "https://www.codecarrot.net/"
4-
image: "/images/partners/codecarrot.png"
2+
title: 'CodeCarrot'
3+
link: 'https://www.codecarrot.net/'
4+
image: '/images/partners/codecarrot.png'
55
description: CodeCarrot is a software agency which brings your idea to life.
66

77
- id: 2
8-
title: "MacStadium"
9-
link: "https://www.macstadium.com/"
10-
image: "/images/partners/macstadium.png"
8+
title: 'MacStadium'
9+
link: 'https://www.macstadium.com/'
10+
image: '/images/partners/macstadium.png'
1111
description: MacStadium provides enterprise-class cloud solutions for Mac and iOS app development.
1212

1313
- id: 3
14-
title: "BrowserStack"
15-
link: "https://www.browserstack.com/"
16-
image: "/images/partners/browserstack.png"
14+
title: 'BrowserStack'
15+
link: 'https://www.browserstack.com/'
16+
image: '/images/partners/browserstack.png'
1717
description: Speed up your release cycles and deploy bug-free websites and mobile apps with BrowserStack.
1818

1919
- id: 4
20-
title: "KeyCDN"
21-
link: "https://www.keycdn.com/"
22-
image: "/images/partners/keycdn.jpg"
20+
title: 'KeyCDN'
21+
link: 'https://www.keycdn.com/'
22+
image: '/images/partners/keycdn.jpg'
2323
description: KeyCDN is the best way to service your content on global network.

‎data/team.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
- id: 1
2-
name: "Yashu Mittal"
3-
title: "Creator of LogChimp"
2+
name: 'Yashu Mittal'
3+
title: 'Creator of LogChimp'
44
avatar: https://avatars.githubusercontent.com/u/29014463?v=4
5-
location: "India"
5+
location: 'India'
66
github: mittalyashu
77
twitter: mittalyashu77

‎docs/cli/commands.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Commands
33
---
44

55
<!-- components -->
6+
67
import Blockquote from "@/components/Blockquote"
78

89
Below are the available LogChimp CLI commands. You can always run `logchimp --help` or `logchimp help [COMMAND]` to get more detail.

‎docs/cli/install.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: logchimp install
33
---
44

55
<!-- components -->
6+
67
import Blockquote from "@/components/Blockquote"
78

89
The `logchimp install` command is your one-stop-shop to get a running production install of LogChimp.

‎docs/cli/start.md

-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,3 @@ USAGE
1212
Running `logchimp start` will start your LogChimp site in the terminal.
1313

1414
The command must be executed in the directory where the LogChimp instance you are trying to start lives.
15-

‎docs/cli/uninstall.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: uninstall
33
---
44

55
<!-- components -->
6+
67
import Blockquote from "@/components/Blockquote"
78

89
Safely removes a LogChimp installation and all related configuration & data.
@@ -31,9 +32,9 @@ The following prompts appear:
3132

3233
The following tasks are performed:
3334

34-
* Remove content folder
35-
* Remove configuration files
36-
* Remove LogChimp instance
35+
- Remove content folder
36+
- Remove configuration files
37+
- Remove LogChimp instance
3738

3839
<Blockquote type="warning">
3940
Running `logchimp uninstall -f` or `logchimp uninstall --force` will skip the warning and remove LogChimp without a prompt.

‎docs/config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Configuration
33
---
44

55
<!-- components -->
6+
67
import Blockquote from "@/components/Blockquote"
78

89
Step by step guide for you to configure LogChimp site using `logchimp.config.json` file.
@@ -23,7 +24,6 @@ LogChimp supports three environments: **development**, **testing**, **production
2324

2425
There are number of options which are explained in detail below.
2526

26-
2727
<Blockquote type="alert">
2828
The configuration below is just an example and not recommended for production use.
2929
</Blockquote>

‎docs/contributing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Or, if you're looking for something a little more challenging, there's a broader
1616

1717
The primary way to contribute to LogChimp is by writing code, but if you're not a developer here are still ways you can help. We always need help with:
1818

19-
* Maintaining documentation
20-
* Testing and quality assurance
21-
* Promoting LogChimp to others
19+
- Maintaining documentation
20+
- Testing and quality assurance
21+
- Promoting LogChimp to others
2222

2323
### Donations
2424

‎docs/install/docker.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,7 @@ Here's an LogChimp Docker image structure for you to understand _(if you're curi
6262

6363
### Resources
6464

65-
* [LogChimp Docker image on GitHub](https://github.com/orgs/logchimp/packages/container/package/logchimp)
66-
* [Reporting issues](https://github.com/logchimp/docker)
65+
- [LogChimp Docker image on GitHub](https://github.com/orgs/logchimp/packages)
66+
- Reporting issues
67+
- [logchimp-server](https://github.com/logchimp/logchimp)
68+
- [logchimp-theme](https://github.com/logchimp/theme)

‎docs/install/gitpod.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Run LogChimp in Gitpod
33
---
44

55
<!-- components -->
6+
67
import Blockquote from "@/components/Blockquote"
78

89
Want to give a quick spin to LogChimp?

‎docs/install/readme.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@ title: How to install LogChimp
33
---
44

55
<!-- components -->
6+
67
import SelfhostInstall from "@/components/SelfhostInstall"
78
import CloudHosting from "@/components/CloudHosting"
89

910
There are few ways you can set up a LogChimp site.
11+
1012
## Self-hosting
1113

1214
If you're running a self-hosted instance, we strongly recommend an Ubuntu server with at least 1GB of memory to run LogChimp.

‎docs/install/render.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: How to deploy LogChimp on Render?
33
---
44

55
<!-- components -->
6+
67
import Blockquote from "@/components/Blockquote"
78

89
A full guide for running LogChimp on Render with a click of a button.
@@ -20,6 +21,7 @@ Clicking on "Deploy to Render" button will redirect you to confirmation page.
2021
Click "apply" button, 🎉 Voilà!
2122

2223
## Configuration
24+
2325
#### logchimp-api
2426

2527
Now, the deployed services needs to be connected together.

‎docs/install/source.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,18 @@ title: Install from Source
33
---
44

55
<!-- components -->
6+
67
import Blockquote from "@/components/Blockquote"
78

89
This guide is for installing a local development copy of LogChimp from source code, primarily for development purposes.
10+
911
## Prerequisites
1012

1113
Before getting started, you'll need these global packages to be installed:
1214

13-
* [Node.js](https://nodejs.org/) (v12) - easiest way to install via [nvm](https://github.com/creationix/nvm#install-script)
14-
* [Yarn](https://yarnpkg.com/en/docs/install#alternatives-tab) - to manage dependencies
15-
* [PostgreSQL](#setup-postgresql-database) (v12) - postgres database
15+
- [Node.js](https://nodejs.org/) (v12) - easiest way to install via [nvm](https://github.com/creationix/nvm#install-script)
16+
- [Yarn](https://yarnpkg.com/en/docs/install#alternatives-tab) - to manage dependencies
17+
- [PostgreSQL](#setup-postgresql-database) (v12) - postgres database
1618

1719
You can read more about engine requirements from [package.json](https://github.com/logchimp/logchimp/blob/master/package.json) on GitHub.
1820

@@ -24,8 +26,8 @@ First, you'll need to make a fork of the [LogChimp](https://github.com/logchimp/
2426
You'll also need a LogChimp theme as client to intract with LogChimp APIs.
2527
</Blockquote>
2628

27-
* LogChimp Core - https://github.com/logchimp/logchimp
28-
* LogChimp default theme - https://github.com/logchimp/theme
29+
- LogChimp Core - https://github.com/logchimp/logchimp
30+
- LogChimp default theme - https://github.com/logchimp/theme
2931

3032
## Install dependencies
3133

@@ -39,9 +41,9 @@ Once you run the command at the root repository, it will install all the require
3941

4042
There are a few ways to set up a database.
4143

42-
* Download the [official Postgres package](https://www.postgresql.org/download/)
43-
* Run a [postgres docker container](https://hub.docker.com/_/postgres)
44-
* Use a remote or self-managed database
44+
- Download the [official Postgres package](https://www.postgresql.org/download/)
45+
- Run a [postgres docker container](https://hub.docker.com/_/postgres)
46+
- Use a remote or self-managed database
4547

4648
To spin up a database quickly and easily on your local machine, we recommend you to use the PostgreSQL docker image.
4749

‎docs/install/ubuntu.md

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ You can use this 👉 [DigitalOcean](https://m.do.co/c/bb349ea15324) 👈 link a
2222
Save time with LogChimp VALET.
2323

2424
This is a detailed manual install guide for developers. If you don't want to deal setting up LogChimp yourself, we offer <a href="/valet">LogChimp VALET</a> services.
25+
2526
</Blockquote>
2627

2728
## Prerequisites

‎docs/principles.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ We've maintained a track of 4-6 months of product roadmap which defines the over
1010

1111
Currently our primary focus is:
1212

13-
* Making LogChimp more flexible and easy to integrate with other apps & services
14-
* Creating a sustainable business models for team to continue working on LogChimp
15-
* Refining and improving the core functionality of the product
13+
- Making LogChimp more flexible and easy to integrate with other apps & services
14+
- Creating a sustainable business models for team to continue working on LogChimp
15+
- Refining and improving the core functionality of the product

‎docs/readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ LogChimp is an open-source software to capture your customers feedback and infor
1010

1111
## Quick start
1212

13-
* Read more about LogChimp's architecture and key features.
14-
* [Setup LogChimp](/docs/install) on your own servers.
15-
* We would love to see you contribute to LogChimp. Get more information on [how to contribute](/docs/contributing).
13+
- Read more about LogChimp's architecture and key features.
14+
- [Setup LogChimp](/docs/install) on your own servers.
15+
- We would love to see you contribute to LogChimp. Get more information on [how to contribute](/docs/contributing).
1616

1717
### Background
1818

‎package.json

+5-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
"scripts": {
55
"build": "gridsome build",
66
"develop": "gridsome develop",
7-
"explore": "gridsome explore"
7+
"explore": "gridsome explore",
8+
"prettier": "prettier --write \"**/*.{yaml,yml,md}\"",
9+
"prepare": "husky install"
810
},
911
"engines": {
1012
"node": ">=12"
@@ -24,7 +26,9 @@
2426
"eslint-plugin-prettier": "^3.4.0",
2527
"eslint-plugin-standard": "^5.0.0",
2628
"eslint-plugin-vue": "^7.14.0",
29+
"husky": "^7.0.1",
2730
"node-sass": "^4.14.1",
31+
"prettier": "^2.3.2",
2832
"sass-loader": "7.3.1"
2933
}
3034
}

‎render.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
previewsEnabled: true
22
services:
33
- type: web
4-
name: "logchimp.codecarrot.net"
4+
name: 'logchimp.codecarrot.net'
55
env: static
66
buildCommand: yarn build
77
staticPublishPath: ./dist

‎src/components/DocsSidebar.vue

+1-3
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@
2222
</template>
2323

2424
<script>
25-
import {
26-
FileText as FileIcon
27-
} from "lucide-vue";
25+
import { FileText as FileIcon } from "lucide-vue";
2826
2927
export default {
3028
name: "DocsSidebar",

‎yarn.lock

+10
Original file line numberDiff line numberDiff line change
@@ -5370,6 +5370,11 @@ https-browserify@^1.0.0:
53705370
resolved "https://registry.yarnpkg.com/https-browserify/-/https-browserify-1.0.0.tgz#ec06c10e0a34c0f2faf199f7fd7fc78fffd03c73"
53715371
integrity sha1-7AbBDgo0wPL68Zn3/X/Hj//QPHM=
53725372

5373+
husky@^7.0.1:
5374+
version "7.0.1"
5375+
resolved "https://registry.yarnpkg.com/husky/-/husky-7.0.1.tgz#579f4180b5da4520263e8713cc832942b48e1f1c"
5376+
integrity sha512-gceRaITVZ+cJH9sNHqx5tFwbzlLCVxtVZcusME8JYQ8Edy5mpGDOqD8QBCdMhpyo9a+JXddnujQ4rpY2Ff9SJA==
5377+
53735378
iconv-lite@0.4.24:
53745379
version "0.4.24"
53755380
resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b"
@@ -8018,6 +8023,11 @@ prettier@^1.18.2:
80188023
resolved "https://registry.yarnpkg.com/prettier/-/prettier-1.19.1.tgz#f7d7f5ff8a9cd872a7be4ca142095956a60797cb"
80198024
integrity sha512-s7PoyDv/II1ObgQunCbB9PdLmUcBZcnWOcxDh7O0N/UwDEsHyqkW+Qh28jW+mVuCdx7gLB0BotYI1Y6uI9iyew==
80208025

8026+
prettier@^2.3.2:
8027+
version "2.3.2"
8028+
resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.3.2.tgz#ef280a05ec253712e486233db5c6f23441e7342d"
8029+
integrity sha512-lnJzDfJ66zkMy58OL5/NY5zp70S7Nz6KqcKkXYzn2tMVrNxvbqaBpg7H3qHaLxCJ5lNMsGuM8+ohS7cZrthdLQ==
8030+
80218031
pretty-error@^2.0.2:
80228032
version "2.1.2"
80238033
resolved "https://registry.yarnpkg.com/pretty-error/-/pretty-error-2.1.2.tgz#be89f82d81b1c86ec8fdfbc385045882727f93b6"

0 commit comments

Comments
 (0)
Please sign in to comment.