Skip to content

BradleyA/user-files

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

user-files

GitHub Stable Release GitHub Release Date GitHub Commits Since GitHub Last Commits

Open GitHub Issue GitHub Open Issues GitHub Closed Issues GitHub pull requests GitHub pull requests

GitHub Repo Clones GitHub Repo Views GitHub Size Language Bash MIT License


Testing other links from other repositories:

Go Report Card GoDoc Docker Container Image Size Docker Container Layers Docker Container Pulls

Go Report Card Pipeline Status Donate

Donate Docker Build Status Docker Pulls Discord

Join the chat at https://gitter.im/hypriot/talk Build Status Latest Release All Releases Donate using Liberapay


Latest Release All Releases


GitHub contributors GitHub pull-requests GitHub pull-requests closed

Demo ⭐ 🌠 🚧 πŸ‘€ :octocat: ⚠️ πŸ“ 🐧 πŸ’‘ https://gist.github.com/rxaviers/7360908


Goal

General user files, dot files, with a few special tweeks to make my system time better. When setting up a new system, I pull these files to update my user profiles.

If you like this repository, select in the upper-right corner, GitHub stars, thank you.

Table of content

Table of content



Description

template directory, there are a few template files (sh,py) that include production standards that I designed as best practices when creating new scripts. When creating a new script I merge sections of code needed from a template file. Some of the production standards are --help, DEBUG, log format, shellcheck, Documentation Language, Copyright, Architecture tree, Default variable value, --usage, and Parse CLI options and arguments. When a production standard is changed it's verson number is updated with the git tag version number. This allows scripts in development, test, and production to be maintianed with the latest production standard verson.

Return to top

Clone

To Install, change into a directory that you want to download the scripts. Use git to pull or clone these scripts into the directory. If you do not have Git installed then enter; "sudo apt-get install git" if using Debian/Ubuntu. Other Linux distribution install methods can be found here: https://git-scm.com/download/linux. On the GitHub page of this script use the "HTTPS clone URL" with the 'git clone' command.

git clone https://github.com/BradleyA/user-files.git
cd user-files

Return to top

Install dot Files

To copy/over-write dot files into your home directory enter the following steps.

cd
git clone https://github.com/BradleyA/user-files.git
user-files/bin/copy-user-dot
rm -rf ./user-files

Return to top

Install a File

To download the latest commit of one of these files, for example .gitignore, change to the location you want to download. If in sub-directory on Github include the directory; example FILEX=bin/term-layout.sh

FILEX=.gitignore
curl -L https://api.github.com/repos/BradleyA/user-files/tarball | tar -xzf - --wildcards BradleyA-user-files-*/$FILEX ; mv BradleyA-user-files-*/$FILEX . ; rm -r BradleyA-user-files-*/

Return to top

Files

.bash_aliases

.bashrc

.dockerignore

.gitconfig

.gitignore

.profile

.vimrc

./ssh/config

./bin/find-code.sh

./etc/ssh/(ssh_config-$HOSTNAME, sshd_config-$HOSTNAME)

./hooks/(post-commit, pre-commit, README.md, var-git-test.examples)

./template/template.py

./template/template.sh

./template/TEST/template.sh/(FVT-option-TEST_CASES , FVT-setup.sh)

Return to top


Contribute

Please do contribute! Issues, comments, and pull requests are welcome. Thank you for your help improving software.

Return to top

Author

Follow @bradleyaustintx GitHub followers

Return to top

Stars

Stargazers repo roster for @BradleyA/user-files

Return to top

Forks

Forkers repo roster for @BradleyA/user-files

Return to top

Tested OS

  • Ubuntu 14.04.6 LTS (amd64,armv7l)
  • Ubuntu 16.04.7 LTS (amd64,armv7l)
  • Ubuntu 18.04.5 LTS (amd64,armv7l)
  • Raspbian GNU/Linux 10 (buster)

Return to top

Design Principles

  • Have a simple setup process and a minimal learning curve
  • Be usable as non-root
  • Be easy to install and configure

Return to top

License

MIT License

Copyright (c) 2020 Bradley Allen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Return to top