Skip to content
Project setup guidelines for my personal projects
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig
.eslintrc.js
.gitignore
.prettierrc.js
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
commitlint.config.js
package.json
yarn.lock

README.md

Some Awesome Project

Project setup guidelines for my personal projects.

license

GitHub

Step 1 - Create a new repository

Write the name and description (add readme and license)

Step 2 - Clone with SSH

Clone the online repo.

cd ~/web
git clone git@github.com:SandroMiguel/<SOME-AWESOME-PROJECT>.git
cd <SOME-AWESOME-PROJECT>
code .

Step 3 - Add .gitignore

Use gitignore-boilerplate

Step 4 - Configure local name and email

I decided to use my professional email globally, and set up another email locally for my personal projects.

git config --local user.name "SandroMiguel"
git config --local user.email "sandromiguel@sandromiguel.com"

Visual Studio Code settings

Step 5 - Configure .vscode/settings.json

{
  "window.zoomLevel": 0,
  "editor.tokenColorCustomizations": {
    "comments": "#FFF",
    "variables": "#FF6D4A",
    "functions": "#00B2BF",
    "strings": "#FFF",
    "numbers": "#518EAF",
    "keywords": "#337DED",
    "types": "#ffaa00",
    "textMateRules": [
      {
        "scope": "comment",
        "settings": {
          "foreground": "#FFF"
        }
      }
    ]
  },
  "editor.fontSize": 15,
  "gitlens.codeLens.enabled": false,
  "terminal.integrated.cursorStyle": "line",
  "terminal.integrated.copyOnSelection": true,
  "terminal.integrated.cursorBlinking": true,
  "terminal.integrated.fontWeightBold": "normal",
  "terminal.integrated.fontSize": 13,
  "terminal.integrated.drawBoldTextInBrightColors": false,
  "terminal.integrated.fontFamily": "Monospace",
  "javascript.preferences.importModuleSpecifier": "non-relative",
  "terminal.integrated.rendererType": "dom",
  "[javascriptreact]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "explorer.confirmDragAndDrop": false,
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "editor.formatOnSave": true,
  "peacock.favoriteColors": [
    {
      "name": "Angular Red",
      "value": "#b52e31"
    },
    {
      "name": "Auth0 Orange",
      "value": "#eb5424"
    },
    {
      "name": "Azure Blue",
      "value": "#007fff"
    },
    {
      "name": "C# Purple",
      "value": "#68217A"
    },
    {
      "name": "Gatsby Purple",
      "value": "#639"
    },
    {
      "name": "Go Cyan",
      "value": "#5dc9e2"
    },
    {
      "name": "Java Blue-Gray",
      "value": "#557c9b"
    },
    {
      "name": "JavaScript Yellow",
      "value": "#f9e64f"
    },
    {
      "name": "Mandalorian Blue",
      "value": "#1857a4"
    },
    {
      "name": "Node Green",
      "value": "#215732"
    },
    {
      "name": "React Blue",
      "value": "#00b3e6"
    },
    {
      "name": "Something Different",
      "value": "#832561"
    },
    {
      "name": "Vue Green",
      "value": "#42b883"
    }
  ],
  "php-cs-fixer.executablePath": "${extensionPath}/php-cs-fixer.phar",
  "php-cs-fixer.lastDownload": 1559774512768,
  "php.validate.run": "onType",
  "phpcs.showSources": true,
  "phpcs.executablePath": "./vendor/squizlabs/php_codesniffer/bin/phpcs",
  "workbench.colorCustomizations": {
    "activityBar.background": "#7263b5",
    "activityBar.activeBorder": "#cc9d93",
    "activityBar.foreground": "#e7e7e7",
    "activityBar.inactiveForeground": "#e7e7e799",
    "activityBarBadge.background": "#cc9d93",
    "activityBarBadge.foreground": "#15202b",
    "titleBar.activeBackground": "#594a9b",
    "titleBar.inactiveBackground": "#594a9b99",
    "titleBar.activeForeground": "#e7e7e7",
    "titleBar.inactiveForeground": "#e7e7e799",
    "statusBar.background": "#594a9b",
    "statusBarItem.hoverBackground": "#7263b5",
    "statusBar.foreground": "#e7e7e7"
  },
  "peacock.color": "#594a9b",
  "editor.codeActionsOnSave": {
    "source.fixAll": true
  }
}

Package Management

Step 6 - Add package.json

Use package.json-boilerplate

ProTip: Sync Github topics with package.json file keywords

Conventional Commit Messages & Semantic Versioning

Step 7 - Use standard-commit

EditorConfig

Step 8 - Add .editorconfig

Use editorconfig-boilerplate

Linting & Code Formatter

Step 9 - Install eslint-config-cecilia

Add other files

Step 10 - Add CONTRIBUTING.md

Contributing

Want to contribute? All contributions are welcome. Read the contributing guide.

Questions

If you have questions tweet me at @sandro_m_m or open an issue.

License

This project is licensed under the MIT License - see the LICENSE file for details

**~ sharing is caring ~**

You can’t perform that action at this time.