Skip to content

Commit

Permalink
linting, formatting, and dependency updates
Browse files Browse the repository at this point in the history
  • Loading branch information
austintoddj committed Sep 15, 2023
1 parent 1b7a5a6 commit dc95118
Show file tree
Hide file tree
Showing 19 changed files with 3,121 additions and 3,963 deletions.
9 changes: 1 addition & 8 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,5 @@
"plugin:vue/vue3-recommended",
"prettier"
],
"rules": {
"vue/multi-word-component-names": [
"error",
{
"ignores": ["Dashboard", "Settings"]
}
]
}
"rules": {}
}
22 changes: 11 additions & 11 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

Thank you for considering contributing to Canvas! One of the ongoing goals for Canvas is to make it as accessible as possible. If you come across any translation mistakes or issues and want to make a contribution, please [create a pull request](https://github.com/austintoddj/canvas/pulls). If you don't see your native language included in the `lang` directory, feel free to add it.

- [OS Tools](#before-you-get-started)
- [Setup](#setup)
- [Git](#git)
- [Database](#database)
- [Directories](#directories)
- [Installation](#installation)
- [Developing](#developing)
- [OS Tools](#before-you-get-started)
- [Setup](#setup)
- [Git](#git)
- [Database](#database)
- [Directories](#directories)
- [Installation](#installation)
- [Developing](#developing)

## Before you get started

- Make sure the [Vue DevTools](https://chrome.google.com/webstore/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd?hl=en) extension is installed in your Chrome browser
- Add the following function from [Caleb Porzio](https://calebporzio.com/bash-alias-composer-link-use-local-folders-as-composer-dependancies/) to your `~/.bashrc`, `~/.bash_profile` or `~/.zshrc`:
- Make sure the [Vue DevTools](https://chrome.google.com/webstore/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd?hl=en) extension is installed in your Chrome browser
- Add the following function from [Caleb Porzio](https://calebporzio.com/bash-alias-composer-link-use-local-folders-as-composer-dependancies/) to your `~/.bashrc`, `~/.bash_profile` or `~/.zshrc`:

```bash
composer-link() {composer config repositories.local '{"type": "path", "url": "'$1'"}' --file composer.json}
Expand Down Expand Up @@ -77,7 +77,7 @@ php artisan storage:link
```

Statistics are a core component to the app, so it's best to have a large dataset in place when developing. To
generate some, add the following factories to your Laravel app:
generate some, add the following factories to your Laravel app:

```php
<?php
Expand Down Expand Up @@ -162,7 +162,7 @@ You can now run `php artisan db:seed` and you will have a substantial amount of
### Developing

Instead of making and compiling frontend changes in the package, then having to re-publish the assets in the
Laravel app again and again, we can utilize a symlink:
Laravel app again and again, we can utilize a symlink:

```bash
# remove the existing assets from the Laravel app
Expand Down
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# These are supported funding model platforms

github: austintoddj
github: austintoddj
98 changes: 49 additions & 49 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,53 +2,53 @@ name: 🐞 Bug
description: File a bug/issue
labels: [bug]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
System Information:
- **PHP Version**: #.#.#
- **Laravel Version**: #.#.#
- **Database Driver & Version**:
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
System Information:
- **PHP Version**: #.#.#
- **Laravel Version**: #.#.#
- **Database Driver & Version**:
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
80 changes: 40 additions & 40 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
name: 🚀 New feature proposal
description: Suggest an idea for the project
body:
- type: markdown
attributes:
value: |
Thanks for your interest in the project and taking the time to fill out this feature report!
- type: textarea
id: feature-description
attributes:
label: Is your feature request related to a problem? Please describe.
description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
validations:
required: true
- type: textarea
id: suggested-solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternative
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
- type: checkboxes
id: checkboxes
attributes:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Follow our [Code of Conduct](https://github.com/austintoddj/canvas/blob/master/.github/CODE_OF_CONDUCT.md)
required: true
- label: Read the [Contributing Guide](https://github.com/austintoddj/canvas/blob/master/.github/CONTRIBUTING.md).
required: true
- label: Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.
required: true
- type: markdown
attributes:
value: |
Thanks for your interest in the project and taking the time to fill out this feature report!
- type: textarea
id: feature-description
attributes:
label: Is your feature request related to a problem? Please describe.
description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
validations:
required: true
- type: textarea
id: suggested-solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternative
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
- type: checkboxes
id: checkboxes
attributes:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Follow our [Code of Conduct](https://github.com/austintoddj/canvas/blob/master/.github/CODE_OF_CONDUCT.md)
required: true
- label: Read the [Contributing Guide](https://github.com/austintoddj/canvas/blob/master/.github/CONTRIBUTING.md).
required: true
- label: Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.
required: true
6 changes: 3 additions & 3 deletions .github/SPONSORS.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Sponsors

[Canvas](https://trycanvas.app) is a freely available, open source project that gives something back to the greater
[Laravel](https://laravel.com) community. Since blog platforms dominate so much of the Internet today, it makes
sense that there should be a simple, easy-to-use package that can drop into your application with minimal effort.
[Laravel](https://laravel.com) community. Since blog platforms dominate so much of the Internet today, it makes
sense that there should be a simple, easy-to-use package that can drop into your application with minimal effort.

**Financial contributions will never be required to maintain this project**, they are however very much appreciated
. If you've ever used Canvas in your daily work, either personally or professionally, and feel that it has made your
life easier, consider [supporting the project](https://github.com/sponsors/austintoddj) for the price of a coffee.
life easier, consider [supporting the project](https://github.com/sponsors/austintoddj) for the price of a coffee.

If you haven't already, [star the repo](https://github.com/austintoddj/canvas/stargazers) to show your support, it makes a huge difference. Thank you in advance. :-)

Expand Down
56 changes: 28 additions & 28 deletions .github/UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ php artisan canvas:migrate
php artisan canvas:publish
```

- [Upgrading to 7.0.0 from 6.0](#upgrading-to-700-from-60)
- [Upgrading to 6.0.0 from 5.4](#upgrading-to-600-from-54)
- [Upgrading to 5.4.0 from 5.3](#upgrading-to-540-from-53)
- [Upgrading to 5.3.0 from 5.2](#upgrading-to-530-from-52)
- [Upgrading to 5.2.0 from 5.1](#upgrading-to-520-from-51)
- [Upgrading to 5.1.0 from 5.0](#upgrading-to-510-from-50)
- [Upgrading to 7.0.0 from 6.0](#upgrading-to-700-from-60)
- [Upgrading to 6.0.0 from 5.4](#upgrading-to-600-from-54)
- [Upgrading to 5.4.0 from 5.3](#upgrading-to-540-from-53)
- [Upgrading to 5.3.0 from 5.2](#upgrading-to-530-from-52)
- [Upgrading to 5.2.0 from 5.1](#upgrading-to-520-from-51)
- [Upgrading to 5.1.0 from 5.0](#upgrading-to-510-from-50)

## Upgrading to 7.0.0 from 6.0

Expand All @@ -36,21 +36,21 @@ some manual steps to take. Don't worry, they're simple and straightforward.
> Note: The process for migrating data will be unique based on your choice of IDE and database.
The first thing to do is export all data in your Canvas-related tables to a SQL dump. It's important that your export
does **not include** the table structure. You only want INSERT statements in the actual export. *If you do include
CREATE TABLE statements, it'll modify the new tables when importing later*.
does **not include** the table structure. You only want INSERT statements in the actual export. _If you do include
CREATE TABLE statements, it'll modify the new tables when importing later_.

For example, I use [Table Plus](https://tableplus.com). When I exported my data, I made sure to un-check the
_Include table structure_ and _Drop table if exists_ in the export selection screen.

The following tables need to be included in the export:

- `canvas_users`
- `canvas_posts`
- `canvas_posts_tags`
- `canvas_tags`
- `canvas_topics`
- `canvas_views`
- `canvas_visits`
- `canvas_users`
- `canvas_posts`
- `canvas_posts_tags`
- `canvas_tags`
- `canvas_topics`
- `canvas_views`
- `canvas_visits`

Once completed, you can drop those tables from your database.

Expand Down Expand Up @@ -111,20 +111,20 @@ underlying structure of WordPress and similar apps.
The first step is to export all data in Canvas-related tables to a SQL dump. The important part of this step is to make
sure your export does **not include** the table structure. You only want INSERT statements in the actual export
. *If you do include CREATE TABLE statements, it'll modify the new tables when importing later*.
. _If you do include CREATE TABLE statements, it'll modify the new tables when importing later_.

For example, I use [Sequel Pro](http://sequelpro.com). When I exported my data, I made sure to un-check the
Structure and DROP TABLE syntax elements in the export selection screen.

The following tables need to be included in the export:

- `canvas_posts`
- `canvas_posts_tags`
- `canvas_posts_topics`
- `canvas_tags`
- `canvas_topics`
- `canvas_views`
- `canvas_visits`
- `canvas_posts`
- `canvas_posts_tags`
- `canvas_posts_topics`
- `canvas_tags`
- `canvas_topics`
- `canvas_views`
- `canvas_visits`

Once completed, you can drop those tables from your database.

Expand Down Expand Up @@ -155,9 +155,9 @@ determine if you should run into any errors while performing this action.

Once the import is complete, the `user_id` column in the following tables will need to be addressed:

- `canvas_posts`
- `canvas_tags`
- `canvas_topics`
- `canvas_posts`
- `canvas_tags`
- `canvas_topics`

Since those values reflect the user ID from the default `users` table, you'll need to make sure you manually update
those to the correct user IDs when you have them established in `canvas_users`.
Expand All @@ -168,7 +168,7 @@ Since we don't rely on the default `users` table anymore, you'll need create you
simple, just run the following Artisan command:

```bash
php artisan canvas:user admin --email {email}
php artisan canvas:user admin --email {email}
```

That's it! You should jump in right away and update your credentials. Now that you've given yourself Admin access
Expand Down Expand Up @@ -271,7 +271,7 @@ php artisan view:clear
## Upgrading to 5.2.0 from 5.1

> **Important:** The `Canvas\Http\Middleware\ViewThrottle` middleware was renamed to `Canvas\Http\Middleware
> \Session`. Update any usages of this class.
\Session`. Update any usages of this class.

> **Important:** The `meta` field for posts will now only support a title, description, and canonical link. The
> `og_*` and `twitter_*` tags were unnecessarily specific, so they were deprecated. If you use those tags in your
Expand Down
2 changes: 1 addition & 1 deletion .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ blank_issues_enabled: false
contact_links:
- name: Questions & Discussions
url: https://github.com/austintoddj/canvas/discussions
about: Use GitHub discussions for message-board style questions and discussions.
about: Use GitHub discussions for message-board style questions and discussions.
Loading

0 comments on commit dc95118

Please sign in to comment.