{"id":16199108,"url":"https://github.com/sandromiguel/some-awesome-project","last_synced_at":"2026-01-16T00:58:19.552Z","repository":{"id":40290483,"uuid":"232427822","full_name":"SandroMiguel/some-awesome-project","owner":"SandroMiguel","description":"Project setup guidelines for my personal projects","archived":false,"fork":false,"pushed_at":"2024-04-11T07:28:54.000Z","size":842,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-22T18:07:17.819Z","etag":null,"topics":["guidelines","javascript","project","setup"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SandroMiguel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-01-07T22:17:36.000Z","updated_at":"2023-03-04T17:52:54.000Z","dependencies_parsed_at":"2024-03-28T02:05:53.781Z","dependency_job_id":"95117604-85fc-4d21-a35c-5a6458f6580c","html_url":"https://github.com/SandroMiguel/some-awesome-project","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SandroMiguel%2Fsome-awesome-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SandroMiguel%2Fsome-awesome-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SandroMiguel%2Fsome-awesome-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SandroMiguel%2Fsome-awesome-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SandroMiguel","download_url":"https://codeload.github.com/SandroMiguel/some-awesome-project/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246875909,"owners_count":20848048,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["guidelines","javascript","project","setup"],"created_at":"2024-10-10T09:24:18.350Z","updated_at":"2026-01-16T00:58:19.538Z","avatar_url":"https://github.com/SandroMiguel.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Some Awesome Project\n\nA set of project setup guidelines for my personal projects.\n\n[![license](https://img.shields.io/badge/License-MIT-blue.svg?style=flat)](LICENSE)\n\n## Overview\n\n**Some Awesome Project** provides a set of guidelines for setting up my personal projects. Whether you choose to clone an existing repository or create a new one from scratch, these steps will help you get started quickly.\n\n## Getting Started\n\n### Option A: Clone this repo\n\n1. **Create a new repository**: Start by creating a new repository on GitHub with a name and description.\n\n2. **Clone with SSH**: Clone this repository to your local machine using SSH.\n\n```sh\ncd ~/web\ngit clone git@github.com:SandroMiguel/some-awesome-project.git \u003cYOUR-AWESOME-PROJECT\u003e\ncd \u003cYOUR-AWESOME-PROJECT\u003e\ncode .\n```\n\n3. **Configure local name and email**: Customize your Git configuration with your username and email.\n\nI decided to use my professional email globally, and set up another email locally for my personal projects.\n\n```sh\nrm -fr .git\ngit init\ngit config --local user.name \"SandroMiguel\" \u003c--- put your username here\ngit config --local user.email \"sandromiguel@sandromiguel.com\" \u003c--- put your email here\n```\n\n4. **Install the dependencies**\n\n```sh\nyarn\n```\n\n5. **Update the dependencies**\n\n```sh\nyarn upgrade-interactive\n```\n\n6. **Documentation**: Don't forget to write a `README.md` that introduces and explains your project.\n\n---\n\n### Option B: Create a new repo from scratch\n\n1. **Create a new repository**: Start by creating a new repository on GitHub with a name, description, and choose to add a README and license.\n\n2. **Clone with SSH**: Clone the online repository to your local machine using SSH.\n\n```sh\ncd ~/web\ngit clone git@github.com:SandroMiguel/\u003cYOUR-AWESOME-PROJECT\u003e.git\ncd \u003cYOUR-AWESOME-PROJECT\u003e\ncode .\n```\n\n3. **Configure local name and email**: Customize your Git configuration with your username and email.\n\nI decided to use my professional email globally, and set up another email locally for my personal projects.\n\n```sh\ngit config --local user.name \"SandroMiguel\" \u003c--- put your username here\ngit config --local user.email \"sandromiguel@sandromiguel.com\" \u003c--- put your email here\n```\n\n4. **Add `.gitignore`**: Use [gitignore-boilerplate](https://github.com/SandroMiguel/gitignore-boilerplate)\n\n5. **Add `package.json`**: Use [package.json-boilerplate](https://github.com/SandroMiguel/package.json-boilerplate)\n\n**ProTip**: Sync Github topics with `package.json` file keywords\n\n6. **Conventional Commit Messages \u0026 Semantic Versioning**: See [standard-commit](https://github.com/SandroMiguel/standard-commit)\n\n7. **Add `.editorconfig`**: Use [editorconfig-boilerplate](https://github.com/SandroMiguel/editorconfig-boilerplate)\n\n8. **Linting \u0026 Code Formatter**: Install [eslint-config-cecilia](https://github.com/SandroMiguel/eslint-config-cecilia)\n\n9. **Documentation**: Write a `README.md` that introduces and explains your project.\n\n10. **Constributing**: Add [CONTRIBUTING.md](CONTRIBUTING.md)\n\n---\n\n## Visual Studio Code settings\n\n### Configure Workspace\n\n**Workspace** settings\n\n`.vscode/settings.json`\n\n```json\n{\n    \"workbench.colorCustomizations\": {\n        \"activityBar.background\": \"#3eaeca99\",\n        \"activityBarBadge.background\": \"#3eaeca\",\n        \"activityBarBadge.foreground\": \"#000000\",\n        \"titleBar.activeBackground\": \"#157A6E\",\n        \"titleBar.activeForeground\": \"#FEFBFC\",\n        \"statusBar.background\": \"#3eaeca99\",\n        \"statusBarItem.hoverBackground\": \"#4580da\",\n        \"statusBar.foreground\": \"#e7e7e7\"\n    }\n}\n```\n\n**User** settings\n\n`~/.config/Code/User/settings.json`\n\n```json\n{\n    \"[html]\": {\n        \"editor.formatOnSave\": false\n    },\n    \"[javascript]\": {\n        \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n    },\n    \"[javascriptreact]\": {\n        \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n    },\n    \"[json]\": {\n        \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n    },\n    \"[jsonc]\": {\n        \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n    },\n    \"[php]\": {\n        \"editor.defaultFormatter\": \"bmewburn.vscode-intelephense-client\"\n    },\n    \"[typescript]\": {\n        \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n    },\n    \"cSpell.userWords\": [\"autoload\", \"noreferrer\", \"phpcs\", \"stylelint\"],\n    \"diffEditor.ignoreTrimWhitespace\": false,\n    \"editor.codeActionsOnSave\": {\n        \"source.fixAll\": \"explicit\"\n    },\n    \"editor.fontFamily\": \"Fira Code\",\n    \"editor.fontLigatures\": true,\n    \"editor.fontSize\": 16,\n    \"editor.formatOnSave\": true,\n    \"editor.matchBrackets\": \"never\",\n    \"editor.suggest.insertMode\": \"replace\",\n    \"editor.suggest.showWords\": false,\n    \"editor.suggestSelection\": \"first\",\n    \"editor.tokenColorCustomizations\": {\n        \"comments\": \"#b1b1b1\",\n        \"variables\": \"#FF6D4A\",\n        \"functions\": \"#00B2BF\",\n        \"strings\": \"#FFF\",\n        \"numbers\": \"#518EAF\",\n        \"keywords\": \"#337DED\",\n        \"types\": \"#ffaa00\",\n        \"textMateRules\": [\n            {\n                \"scope\": \"comment\",\n                \"settings\": {\n                    \"foreground\": \"#b1b1b1\"\n                }\n            }\n        ]\n    },\n    \"eslint.debug\": true,\n    \"explorer.confirmDelete\": false,\n    \"explorer.confirmDragAndDrop\": false,\n    \"gitblame.statusBarMessageFormat\": \"Blame ${author.name} ( ${author.date} )\",\n    \"javascript.preferences.importModuleSpecifier\": \"non-relative\",\n    \"javascript.updateImportsOnFileMove.enabled\": \"always\",\n    \"php.suggest.basic\": false,\n    \"phpcs.standard\": \"~/phpcs-cecilia-standard\",\n    \"phpcs.executablePath\": \"/home/sandro/.config/composer/vendor/bin/phpcs\",\n    \"security.workspace.trust.untrustedFiles\": \"open\",\n    \"terminal.integrated.copyOnSelection\": true,\n    \"terminal.integrated.cursorBlinking\": true,\n    \"terminal.integrated.cursorStyle\": \"line\",\n    \"terminal.integrated.drawBoldTextInBrightColors\": false,\n    \"terminal.integrated.fontFamily\": \"noto mono\",\n    \"terminal.integrated.fontSize\": 16,\n    \"todo-tree.filtering.includeGlobs\": [\"**/*.php\", \"**/*.js\"],\n    \"typescript.tsserver.log\": \"off\",\n    \"workbench.colorCustomizations\": {\n        \"editorBracketHighlight.unexpectedBracket.foreground\": \"#db6165\",\n        \"editor.findMatchBackground\": \"#cc00aaa8\",\n        \"editor.findMatchHighlightBackground\": \"#1d3d0379\",\n        \"editor.findMatchHighlightBorder\": \"#c1fccd\"\n    },\n    \"workbench.editor.wrapTabs\": true,\n    \"workbench.colorTheme\": \"Visual Studio Dark\",\n    \"files.watcherExclude\": {\n        \"**/.yarn/**\": true\n    },\n    \"editor.wordWrap\": \"on\",\n    \"path-intellisense.autoTriggerNextSuggestion\": true,\n    \"editor.bracketPairColorization.enabled\": false,\n    \"php-docblocker.useShortNames\": true,\n    \"better-comments.tags\": [\n        {\n            \"tag\": \"@deprecated\",\n            \"color\": \"#FFFFFF\",\n            \"strikethrough\": false,\n            \"underline\": false,\n            \"backgroundColor\": \"#FF2D00\",\n            \"bold\": false,\n            \"italic\": false\n        },\n        {\n            \"tag\": \"!\",\n            \"color\": \"#FF2D00\",\n            \"strikethrough\": false,\n            \"underline\": false,\n            \"backgroundColor\": \"transparent\",\n            \"bold\": false,\n            \"italic\": false\n        },\n        {\n            \"tag\": \"?\",\n            \"color\": \"#3498DB\",\n            \"strikethrough\": false,\n            \"underline\": false,\n            \"backgroundColor\": \"transparent\",\n            \"bold\": false,\n            \"italic\": false\n        },\n        {\n            \"tag\": \"//\",\n            \"color\": \"#474747\",\n            \"strikethrough\": true,\n            \"underline\": false,\n            \"backgroundColor\": \"transparent\",\n            \"bold\": false,\n            \"italic\": false\n        },\n        {\n            \"tag\": \"TODO\",\n            \"color\": \"#FF8C00\",\n            \"strikethrough\": false,\n            \"underline\": false,\n            \"backgroundColor\": \"transparent\",\n            \"bold\": false,\n            \"italic\": false\n        },\n        {\n            \"tag\": \"*\",\n            \"color\": \"#98C379\",\n            \"strikethrough\": false,\n            \"underline\": false,\n            \"backgroundColor\": \"transparent\",\n            \"bold\": false,\n            \"italic\": false\n        }\n    ]\n}\n```\n\n## Contributing\n\nWant to contribute? All contributions are welcome. Read the [contributing guide](CONTRIBUTING.md).\n\n## Questions\n\nIf you have questions tweet me at [@sandro_m_m](https://twitter.com/sandro_m_m) or [open an issue](../../issues/new).\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n\n**~ sharing is caring ~**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandromiguel%2Fsome-awesome-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsandromiguel%2Fsome-awesome-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandromiguel%2Fsome-awesome-project/lists"}