Many projects lack sufficient development and preparation in the area of their environment and sometimes are not intended as such at all due to the overall complexity, time-consuming and non-adaptive nature of such a process1.
With this project, all you have to do is run some scripts, edit the necessary data and add your own basic project plugins and you will have a fully customized project from an open source perspective, ready for a development environment not only for you but for others as well.
Project is created and “written” with help of:
Before asking questions, read this block because here is all the primary information on the project, which can answer your future not-yet asked questions.
For usage of this project just as template for your repository, there is no direct prerequisites besides Node.js.
But, for contributing to this project, we highly recommending following those prerequisites:
- Installed Node.js on your desktop on which you will edit/setup this project;
- Installed Python if you want to contribute to the scripts of this project (in terms of .PY scripts);
- It is recommended to use Github CLI on your machine for better experience via working not only within this project, but this the .GIT in entirety;
Permission is granted for free use in any of your products.
If you want to use this project, there are two ways to download-and-use this project: “official” and direct, so, let's start from official path:
- Go up to the “main position” of page of this repository and seek for the "Use this template" button;
- Click on this button and seek for the specified variants "Use this template → Create a new repository", or option with codespaces;
- Use project, edit anything you want.
Guidelines for direct-installation way:
- Download last tag on project's repository, for the last ZIP-tarball link provided below:
download latest release- or just download the source-code through "Code → Download ZIP (or any option that you want)", and proceed to the next step;
- Within downloaded ZIP (or project), clone everything and paste to the directory of your project via "copy+paste" procedure;
- Now, you can use project just as if you installed it from other algorithms.
Guidelines for installation of source code of this project:
- Clone the repository with any form of app which supports git (or CLI of this site), guide is attached:
https://www.howtogeek.com/451360/how-to-clone-a-github-repository/ - Open it with any suitable for you editor and feel free to customize, update and/or contribute to this project2.
Usage of this project is very easy and comfortable for common user, its not provided with any advanced code or anything, it just the "data" which user must interpretate as it wants.
- Go to your project's directory and paste the contents of this template, which were installed with help of installation guides3;
- Now, you can continue to work on your project with this template's data in it.
Before preparing to work on the projects that you prepared, initialize entire repository via initialize and prepare commandlets of NPM (through either bash or powershell):
# Installing every dependency for package:
npm i
# Using prepare script for this repository:
npm run prepare:mainAfter setting up project's template within custom provided script, it is recommended to follow this algorithm:
- You MUST update .GITIGNORE file, for more information and sources, check .GITIGNORE-README;
- You MUST update .GITATTRIBUTES file, for more information and sources, check .GITATTRIBUTES-README;
- If you don't use DOCKER/KUBERNETES, do this:
REMOVE any related file either to DOCKER or KUBERNETES; - It is RECOMMENDED to set up custom workflows for your code;
- It is RECOMMENDED to set up custom attributes for .GITCONFIG of your project (check GITHUB subdirectory);
- It is RECOMMENDED to read applied in this template documentation, you may disagree or want to edit it up;
- It is RECOMMENDED to update LICENSE and README according to your project (image is from README template, for references see links below).
- Upgrade and update project to the second version generation;
- Refactor to project according to integrated linters and pass the checks within future;
- Write small pages website which contains philosophy and common ideology of project and how to use it;
- Format and style it;
- Write a markdown file which contains a pattern for philosohpies or ideologies for projects;
- And write down a specified philosophy for this exact project;
Contributions are what make open source community such an interest place to be in, so any form of contribution are greatly appreciated.
If you think that you can help this project become better but think its not so important/realizable in the current situtation or for a full contribution, use issues page, otherwise there is a guideline and policy for contributing.
If you want to contribute to this project, please, read contributioning policy and commit convention, this repository works with CLA, commits convention and on automated deployment system4.
For one-single file contributioning, use a more quicker way without forking the repository through website.
More about it in this article:
- “Working with forks” about syncing one-file fork;
Project thanks the Electron.js and Angular.js for their amazing repository scripts and entire infrastructure, which partially were imported to this repository.
For individual licensing and credits information, seek correspondive files and/or sources.
Project itself is being distributed under the MIT License — see the file for more specified information.
For any legal purposes, you can contact developer/maintainer through its e-mail:
- Outlook E-mail
You can also check contact information in CODEOWNERS file within referencing our contacts.
If the developer/maintainer didn't answered, or you have other questions in nature, you can use issues page on this repository via specified templates or indirect self-written issue.
- https://shields.io/
- https://simpleicons.org/
- https://gitignore.io/
- https://gitattributes.io/
- this generator is discontinued, use:
https://richienb.github.io/gitattributes-generator/
- this generator is discontinued, use:
- Best README template
Footnotes
-
For this, please, read README and keep in mind, that this is a template and if you want to, you could redefine entire structure of this file or entire repository. ↩
-
for contributing policy, see — CONTRIBUTING.md ↩
-
read the files of commiting convention policy and contributioning policy ↩