spatie / guidelines.spatie.be

The guidelines used at our company

guidelines.spatie.be

This repo contains the source code for our guidelines site.

Support us

Learn how to create a package like this one, by watching our premium video course:

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

Install this package by running cloning this repository and install like you normally install Laravel.

• Run composer install and npm install yarn
• Run yarn and yarn run dev to generate assets
• Copy .env.example to .env and fill your values

Postcardware

If you are following our guidelines or use the code in this repo to set up your own guidelines site, please send us a postcard from your hometown.

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.

All postcards are published on our website.

Support

These guidelines are tailormade for us. We do not follow semver for this project and do not provide support whatsoever. However, if you're a bit familiar with Laravel you should easily find your way.

License

This project and the Laravel framework are open-sourced software licensed under the MIT license.

guidelines.spatie.be's Issues

Create PHP Codestyle page

About route resource conflict in actual laravel output

Hi!

I have notice that this

Spatie Guideline

Route::get('open-source', 'OpenSourceController@index')->name('openSource');

has conflict with

Actual Laravel Output

Route::resource('open-source','OpenSourceController');

output:

GET	open-source	open-source.index	App\Http\Controllers\OpenSourceController@index	web
GET	open-source/create	open-source.create	App\Http\Controllers\OpenSourceController@create	web
POST	open-source	open-source.store	App\Http\Controllers\OpenSourceController@store	web
GET	open-source/{open_source}	open-source.show	App\Http\Controllers\OpenSourceController@show	web
GET	open-source/{open_source}/edit	open-source.edit	App\Http\Controllers\OpenSourceController@edit	web
PUT PATCH	open-source/{open_source}	open-source.update	App\Http\Controllers\OpenSourceController@update	web
DELETE	open-source/{open_source}	open-source.destroy	App\Http\Controllers\OpenSourceController@destroy	web

Is ok to suggest is make snake case a parameter and kebab-case a route name?
if ok can I PR this?

Thank you, Have a nice day

I want to translate this document.

I have confirmed that it is an MIT license, but I would like to confirm two more things

1. Can I translate this document into Korean and provide it?
2. Can I use this project to provide guidelines for other services?

Add analytics

Trying to login results in a whoops page

Social login via Google

Do you also prefer camel case in folder names of views?

Create a dedicated page with Vue guidelines

Possible subjects:

• structure of vue file (proposal, template, script, style
• formatting use of subcomponents in templates (already in JS guidelines)
• naming of subcomponents (proposal: kebab-cased, eg input-field
• naming of events (proposal: image on being prefix but don't actually add it, eg change)
• order of components (proposal: alphabetical)
• prop order on subcomponents (proposal: v-statements first, than props, than event handlers
• order of the basic parts of a component (proposal: props computed, data, mixins, components, created, mounted, methods)
• order of the imports (proposal: alphabetical)

Create a page on Laravel style

Repeated tags

GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GOOGLE_REDIRECT=

Appear twice on your .env file.

Add image credits

Search with Algolia

GitHub edit links

• Not sure where yet
• Navigation files need an optional edit_baseurl attribute for content from other repositories

Update the CSS style guide

Deploy script

• Zero downtime Envoy?
• Should also pull the private contents package somewhere else, and symlink every directory (gonna need a find script)

Add git repo naming conventions to Version control page

• repo names
• branches names

Write an introduction

Create a page on PHP code style

Update the JavaScript style guide

Architecture standards checked by CI

I wonder, there are many rules that could be enforced on sniff/fixer level. That way, developers don't have to remember them and the tool is like their senior colleague.

I realize this has less value if in singe team (like yours) where you teach them, but for everyone else it might be helpful

404 page style