Quickstart

Quickstart tutorial for nvtrev2

DISCLAIMER: I haven't ran through this setup from scratch yet. If you do, any feedback is greatly appreciated. If you run into any issues, check out Troubleshooting.

Prerequisites

macOS

• brew

1. Install NeoVim

Linux

sudo apt-get install neovim

• Neovim docs [Debian]

macOS

brew install neovim

• Neovim docs [macOS]

2. Clone the repo

Create a directory for nvtrev2, cd into it, and clone this repo there

mkdir ~/.config/nvim # This is where the neovim configuration lives by default
cd ~/.config/nvim
git clone $URL . # This clones our project into the directory without the project folder

3. Install NPM (package manager)

Linux

???

• Need to fill this part out.

macOS

brew install node

• Read more about node-js with homebrew on mac

4. Install es-lint

NOTE: This may not be required, as we now handle eslint with mason and that is installed automatically. I am not sure if it will work as desired with the airbnb config. Further testing is required.

If you want to just install this anyways, it won't cause any harm.

Linux or macOS

npm install --save-dev eslint eslint-config-airbnb

Read more:

• Air bnb javascript style guide
• Read about eslints integration with neovim

5. Install nerd fonts

Linux

• https://www.nerdfonts.com/font-downloads
• Linux (Ubuntu specifically)
  • Install nerd font https://www.nerdfonts.com/font-downloads (I used UbuntuMono)
  • https://bytexd.com/how-to-install-nerd-fonts-on-linux/
  • Update your terminal to use the new font!

macOS

brew install --cask font-ubuntu-mono-nerd-font

• NOTE: You can use whatever font you want, but I recommend a mono font (especially if you're using iterm2)

You will want to update your terminal to use the newly downloaded font.

6. Install ripgrep

Linux

sudo apt-get install ripgrep

macOS

brew install ripgrep

Learn more about ripgrep

7. Install black (python autoformatter)

pip install black # you will need to install python if it isn't already installed