Feat: New Instructions

README.md

@@ -1,25 +1,52 @@
-[![Build Stable](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml/badge.svg)](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml)
-[![Build Develop](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml/badge.svg)](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml)
-
-Everything about [Frappe](https://github.com/frappe/frappe) and [ERPNext](https://github.com/frappe/erpnext) in containers.
-
 # Getting Started
 
-To get started you need [Docker](https://docs.docker.com/get-docker/), [docker-compose](https://docs.docker.com/compose/), and [git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) setup on your machine. For Docker basics and best practices refer to Docker's [documentation](http://docs.docker.com).
+**!! You need to be connected to WSL before proceeding**
+
+To get started you need [Docker](https://docs.docker.com/get-docker/), [docker-compose](https://docs.docker.com/compose/), and [git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) setup in WSL. For Docker basics and best practices refer to Docker's [documentation](http://docs.docker.com).
 After that, clone this repo:
 
+## Introduction
+You will be working in the ```./development``` folder a.k.a. workspace. Follow the steps below to set up the workspace.
+
+## Workspace Setup
+
+1. Clone Repo into your working directory
 ```sh
 git clone https://github.com/cronos-capital/RAFNAV-Docker.git
 cd RAFNAV-Docker
 ```
+2. Create the devcontainer and VsCode configuration from the templates provided
+```sh
+cp -R devcontainer-example .devcontainer
+cp -R development/vscode-example development/.vscode
+```
 
-### Try in Play With Docker
+## Build the Image
 
-<a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/frappe/frappe_docker/main/pwd.yml">
+Run the following command in your working directory
-  <img src="https://raw.githubusercontent.com/play-with-docker/stacks/master/assets/images/button.png" alt="Try in PWD"/>
+```sh
-</a>
+docker build -t rafnav_bench:latest ./images/bench
+```
 
-Wait for 5 minutes for ERPNext site to be created or check `create-site` container logs before opening browser on port 8080. (username: `Administrator`, password: `admin`)
+## Container Initialization
+1. Open the command pallet with *ctrl + shift + p*  or  *View->Command Pallet*
+
+2. Run the command ```dev containers: rebuild and reopen in container```
+3. Wait for the container to warm up...
+
+# Starting Development
+
+1. Run the installer
+```sh
+frap-install
+```
+**Note: For additional args and configs run ```frap-install --help``` first.**
+
+2. cd into rafnav's development bench
+```sh
+cd rafnav_bench
+```
+3. Now you are able to start development on RAFNAV with all the dependencies and correct environment set up.
 
 # Documentation
 
@@ -36,25 +63,8 @@ Wait for 5 minutes for ERPNext site to be created or check `create-site` contain
 - [Migrate from multi-image setup](docs/migrate-from-multi-image-setup.md)
 - [running on linux/mac](docs/setup_for_linux_mac.md)
 
-### [Custom Images](#custom-images)
-
-- [Custom Apps](docs/custom-apps.md)
-- [Build Version 10 Images](docs/build-version-10-images.md)
 
 ### [Development](#development)
 
-- [Development using containers](docs/development.md)
 - [Bench Console and VSCode Debugger](docs/bench-console-and-vscode-debugger.md)
 - [Connect to localhost services](docs/connect-to-localhost-services-from-containers-for-local-app-development.md)
-
-### [Troubleshoot](docs/troubleshoot.md)
-
-# Contributing
-
-If you want to contribute to this repo refer to [CONTRIBUTING.md](CONTRIBUTING.md)
-
-This repository is only for container related stuff. You also might want to contribute to:
-
-- [Frappe framework](https://github.com/frappe/frappe#contributing),
-- [ERPNext](https://github.com/frappe/erpnext#contributing),
-- [Frappe Bench](https://github.com/frappe/bench).