Merge branch 'main' of github.com:dittonjs/NestStarterApp
This commit is contained in:
commit
f5193541f6
47
ASDFVM_SETUP.md
Normal file
47
ASDFVM_SETUP.md
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
# ASDFVM Setup
|
||||||
|
1. Run
|
||||||
|
```bash
|
||||||
|
$ git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.8.1
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Run
|
||||||
|
```bash
|
||||||
|
$ code ~/.bashrc
|
||||||
|
```
|
||||||
|
This assumes you have VS Code installed on your computer (if you don't then install it by searching for it online and installing it).
|
||||||
|
|
||||||
|
3. Add the following lines at the end of the file and save it.
|
||||||
|
```bash
|
||||||
|
. $HOME/.asdf/asdf.sh
|
||||||
|
. $HOME/.asdf/completions/asdf.bash
|
||||||
|
```
|
||||||
|
4. If you are on Mac make sure you have homebrew installed.
|
||||||
|
`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
|
||||||
|
5. Close your terminal and reopen it.
|
||||||
|
|
||||||
|
## Installing the NodeJS plugin
|
||||||
|
1. Install the plugin
|
||||||
|
```bash
|
||||||
|
$ asdf plugin add nodejs https://github.com/asdf-vm/asdf-nodejs.git
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installing the Postgres plugin
|
||||||
|
1. Install the dependencies
|
||||||
|
|
||||||
|
Mac
|
||||||
|
```bash
|
||||||
|
$ brew install gcc readline zlib curl ossp-uuid
|
||||||
|
```
|
||||||
|
|
||||||
|
Ubuntu
|
||||||
|
```
|
||||||
|
$ sudo apt-get install linux-headers-$(uname -r) build-essential libssl-dev libreadline-dev zlib1g-dev libcurl4-openssl-dev uuid-dev
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Install the plugin
|
||||||
|
```
|
||||||
|
$ asdf plugin-add postgres
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Restart your terminal when it is done.
|
16
README.md
16
README.md
@ -29,10 +29,20 @@ To retrieve changes from the starter app run
|
|||||||
$ git pull upstream main
|
$ git pull upstream main
|
||||||
```
|
```
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
### VSCode
|
||||||
|
I know there are bunch of editors but trust me, VS Code will make your life easier, mostly becuase it is what I use and if you have issues I can help you. If you use something else IT WILL BE YOUR RESPONSIBILITY TO MAKE SURE IT IS CONFIGURED PROPERLY.
|
||||||
|
|
||||||
|
Look [here](/VSCODE.md) for information about which extensions and settings we will use.
|
||||||
|
|
||||||
|
### WSL
|
||||||
|
If you are on Windows you will need to install WSL2 you must be on windows 10 or higher.
|
||||||
|
You can find the instructions on how to set this up [here.](/WSL_SETUP.md)
|
||||||
|
|
||||||
### asdf-vm
|
### asdf-vm
|
||||||
Tool versions are managed using `asdf-vm`. You will need to have `asdf-vm` installed first.
|
Tool versions are managed using `asdf-vm`. You will need to have `asdf-vm` installed first. You can install it by following the instructions [here.](/ASDFVM_SETUP.md)
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
Make sure your have navigated to the project directory in your terminal.
|
||||||
### Tool versions
|
### Tool versions
|
||||||
Install the tool versions by running
|
Install the tool versions by running
|
||||||
```bash
|
```bash
|
||||||
@ -190,7 +200,3 @@ We finally made it! To deploy your app to Heroku run
|
|||||||
$ git push heroku main
|
$ git push heroku main
|
||||||
```
|
```
|
||||||
and thats it!
|
and thats it!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
9
VSCODE.md
Normal file
9
VSCODE.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# VS Code
|
||||||
|
## Extensions
|
||||||
|
These are the extensions you should install into VS Code
|
||||||
|
|
||||||
|
- ESLint (Microsoft)
|
||||||
|
- Tailwind CSS Intellisense (Tailwind Labs)
|
||||||
|
|
||||||
|
## Settings
|
||||||
|
Press `Ctrl+,` or `Cmd+,` to open your settings and make sure the box for `Editor: Insert Spaces` is checked and set `Editor: Tab Size` to 2.
|
14
WSL_SETUP.md
Normal file
14
WSL_SETUP.md
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
# Setup WSL
|
||||||
|
1. Open the `Turn Windows features on or off` page in the Control Panel
|
||||||
|
2. Enable `Window Subsystem for Linux` and `Virtual Machine Platform`
|
||||||
|
3. Restart your computer
|
||||||
|
4. Install windows terminal from the Microsoft app store.
|
||||||
|
5. Open Windows Terminal
|
||||||
|
6. Run the command `wsl --set-default-version 2`
|
||||||
|
7. Run the command `wsl --install -d Ubuntu`
|
||||||
|
8. Fill out the information when the new window opens.
|
||||||
|
9. In your ubuntu terminal create an ssh-key by running `ssh-keygen`. I would just leave everything as the default including the password empty for this key.
|
||||||
|
10. Get your public key by running `cat ~/.ssh/id_rsa.pub` in your ubuntu terminal.
|
||||||
|
11. Add that key to github.
|
||||||
|
12. In the Windows Terminal app setting set the default profile to be Ubuntu (you may need to close windows terminal and reopen it for Ubuntu to show up.)
|
||||||
|
|
Loading…
Reference in New Issue
Block a user