Skip to content

Instantly share code, notes, and snippets.

@withchandra
Last active August 26, 2020 13:51
Show Gist options
  • Save withchandra/667f45a35cc10c2b110c0c543089cfc9 to your computer and use it in GitHub Desktop.
Save withchandra/667f45a35cc10c2b110c0c543089cfc9 to your computer and use it in GitHub Desktop.
Default README.md for initial project

README / BACA DULU

This is Talenavi default readme file, please add important instruction here based on each project.

Preparation before cloning / Persiapan sebelum clone

  • Make sure your PHP version is suitable with this laravel
  • You have installed composer (https://getcomposer.org)
  • You have installed nodeJS (https://nodejs.org)
  • Make sure you have npm ready by running npm --version

What to do after cloning / Langkah setelah melakukan clone

  • Enter your repository folder
  • Run composer install
  • Run npm install (necessary for implementing git hooks and linting)
  • Prepare .env file cp .env.example .env and vim .env and adjust to your local machine settings
  • Do the migration php artisan migrate --seed
  • add any necessary step for deployment such as php artisan link:storage etc.

What is commitlint? / Apa itu commitlint?

CommitLint will help our commit message in standard and easy to understand.
Please see this https://commitlint.js.org/

What is eslint? / Apa itu eslint?

Eslint and prettier will help our code to be in standard.
Please see this https://eslint.org/

What is git-flow? / Apa itu git-flow?

Git-flow is one of standard rules to separate branches by each workflow such as master, develop, release-* etc.
Please see this https://nvie.com/posts/a-successful-git-branching-model/

Mockup

link goes here...

Staging Server

link goes here...

Live Server

link goes here...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment