rayanramoul / RayTerm

A very opiniated configuration for your software development workflow.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

RayTerm

  MacOS Setup RayTerm Windows and WSL Setup RayTerm ArchLinux Setup RayTerm

Get Started with one command (Linux and MacOS only)

sh -c "$(wget https://raw.githubusercontent.com/rayanramoul/RayTerm/master/install.sh -O -)"

The script will clone this repository and install ansible then prompt you to choose which part of the install you want to run.
If you only want to check the dotfiles you can get them at this link : Dotfiles and for example run Stow to symlink your config with the repositories ones :

git clone https://github.com/rayanramoul/RayTerm/
cd RayTerm
stow -t $HOME -R dotfiles

Or if you want a minimal setup for a server (only copy dotfiles) you can run the following command :

sh -c "$(wget https://raw.githubusercontent.com/rayanramoul/RayTerm/master/install_minimal.sh -O -)" -- -m

for Windows you can check the Windows doc

What is this ?

RayTerm is a set of configuration, dotfiles and software to ensure a vision on the optimal environement to code in. It is :

  • Tiling Window Management.
  • Coherent and reproducible workflows from an OS to another.
  • Strongly relying on terminal tools : Neovim, Tmux, Zsh, Fzf, etc.
  • All prettier with Catppuccin !

How ?

The idea is to have one main key associated with each part of the system

  • Alt for the window manager.
  • Ctrl for the terminal.
  • Ctrl + b for tmux.
  • Ctrl and Space for neovim.

Docs

You can find my documentation of each part of my workflow in the docs folder.

  • Neovim: My neovim configuration.
  • Terminal: My terminal configuration.
  • Tmux: My tmux configuration.
  • ArchLinux: My ArchLinux workflow guide.
  • MacOS: My MacOS workflow guide.
  • Windows: My Windows workflow guide.

Development

This repository is delivered with a set of Dockefiles to ensure a reproducible development environement. So if you want to altere it and test it let's say on Ubuntu you can do it with the following command :

cd docker
bash build_test_docker.sh ubuntu

It will build the docker image (omitting the cache) and run it in interactive mode. Possible arguments being : ubuntu, arch, macos, aws.

❤️ Enjoying RayTerm?

If RayTerm has been helpful to you, please consider giving it a star! ⭐ It helps others discover the repository and shows appreciation for the effort put into creating and maintaining it.

Thank you for your support! 🚀

About

A very opiniated configuration for your software development workflow.

License:Apache License 2.0


Languages

Language:Shell 63.1%Language:Lua 16.9%Language:Python 16.1%Language:SCSS 1.8%Language:Perl 1.3%Language:CSS 0.5%Language:Dockerfile 0.4%