Skip to content

Commit

Permalink
Merge pull request #1 from nstankov-bg/initial-collection
Browse files Browse the repository at this point in the history
Initial Collection
  • Loading branch information
nstankov-bg authored Apr 12, 2021
2 parents ed0b1de + 6379fde commit 6591134
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 9 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Plutus Community Documentation.
Please feel free to [contribute.](http://github.com/nstankov-bg/docs.plutus-community.com)

# Intro

Hey! The documentation for Plutus is pretty lacking so far, so we decided to make our own, as a community :)
Expand All @@ -8,3 +11,4 @@ The website is hosted on a single node, that runs in a utility-room, somewhere.
The page lives [here](http://docs.plutus-community.com)

Version 0.01a

1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@

* [MacOS](/docs/setup/MacOS.md)
* [Vagrant(VM)](/docs/setup/Vagrant.md)
* [Ubuntu OS](/docs/setup/Ubuntu.md)
43 changes: 43 additions & 0 deletions docs/setup/Ubuntu.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Ubuntu setup for Plutus Playround

## Steps

* Cone plutus repo from [here](https://github.com/input-output-hk/plutus)
* From terminal do the following:

```ssh
sudo mkdir -p /etc/nix/
mkdir -p ~/.config/nix
sudo touch /etc/nix/nix.conf
touch ~/.config/nix/nix.conf
```

* Paste the following in `~/.config/nix/nix.conf` and `/etc/nix/nix.conf`

```ssh
substituters = https://hydra.iohk.io/ https://iohk.cachix.org/ https://cache.nixos.org/
trusted-public-keys = hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= iohk.cachix.org-1:DpRUyj7h7V830dp/i6Nti+NEO2/nhblbov/8MW7Rqoo= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
```

* Navigate to the Plutus folder (from the Git Clone in Step 1) and paste this:

```ssh
nix build -f default.nix plutus.haskell.packages.plutus-core
```

* Open two terminal windows.
* In terminal window 1 (from the root of the Plutus project):

```ssh
nix-shell
cd plutus-playground-server
plutus-playground-server
```

* In terminal window 2 (from the root of the Plutus project):

```ssh
nix-shell
cd plutus-playground-client
npm run start
```
18 changes: 9 additions & 9 deletions docs/setup/Vagrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,31 @@ Go give him a star!

## Installation

1. Navigate to a directory of your choice and do
* Navigate to a directory of your choice and do

```ssh
git clone https://github.com/edwint88/plutus-vm plutus-vm
```

2. Navigate to inner-folder called vagrant.
* Navigate to inner-folder called vagrant.

```ssh
cd plutus-vm/vagrant/
```

3. In the Vagrantfile directory run & wait for provisioning to finish:
* In the Vagrantfile directory run & wait for provisioning to finish:

```ssh
cd vagrant && vagrant up
```

4. When it finished provisioning, open TWO terminal windows and run in each:
* When it finished provisioning, open TWO terminal windows and run in each:

```ssh
vagrant ssh
```

5. In Terminal Window 1:
* In Terminal Window 1:

```ssh
cd /home/vagrant/plutus/git/plutus
Expand All @@ -46,7 +46,7 @@ cd plutus-playground-client
plutus-playground-server
```

6. In Terminal Window 2:
* In Terminal Window 2:

```ssh
cd /home/vagrant/plutus/git/plutus
Expand All @@ -55,12 +55,12 @@ cd plutus-playground-client
npm run start
```

7. Go in your browser at https://192.168.5.21:8009 (if you changed the VM IP go to that IP)
8. How to SSH-Remote: https://medium.com/@lopezgand/connect-visual-studio-code-with-vagrant-in-your-local-machine-24903fb4a9de
* Go in your browser at https://192.168.5.21:8009 (if you changed the VM IP go to that IP)
* How to SSH-Remote: https://medium.com/@lopezgand/connect-visual-studio-code-with-vagrant-in-your-local-machine-24903fb4a9de

## Tips & Tricks

1. If you need ghc or cabal you can enter a folder with `default.nix` and run `nix-shell` over there and then change to your directory where you need to run cabal. E.g. `cd /home/vagrant/plutus/git/plutus` => `nix-shell` => `cd ../plutus-pioneer-program/code/week1` => `cabal build`
* If you need ghc or cabal you can enter a folder with `default.nix` and run `nix-shell` over there and then change to your directory where you need to run cabal. E.g. `cd /home/vagrant/plutus/git/plutus` => `nix-shell` => `cd ../plutus-pioneer-program/code/week1` => `cabal build`


## Credits
Expand Down

0 comments on commit 6591134

Please sign in to comment.