Getting Started
This page is intended for less experienced programmers who are unfamiliar with typescript, Vue, PHP or coding in general. If you don't fall under this category, you can follow the readme.md to get started. This guide would assume that the user has a editor/compiler such as Sublime + Ubuntu or an IDE that can run JS and PHP.
SECTIONS:
- Docker
- Composer
Follow the below link and its respective instruction to install
Windows Requirements
- WSL 2
- Hyper-V
- Windows 10
https://docs.docker.com/desktop/windows/install/
Linux Requirements
- KVM
- Ubuntu || Debian || Fedora || Arch
https://docs.docker.com/desktop/linux/install/
Mac
https://docs.docker.com/desktop/mac/install/
Follow the below link to install Composer
https://getcomposer.org/download/
Creation of a local copy of the repository would be the next step. There are two options that fulfill it which are using Github Desktop or using command line.
GitHub Desktop
Using GitHub Desktop is straight forward. Click on the link: https://desktop.github.com/ to bring you to the installation page of Desktop, once it has been installed.
-
Go to the repository on the GitHub website and click on
-
It should bring up a popup and there should be a option within it to open with GitHub desktop and then create a local directory where the repo would go
-
Once done, there should be a repository that is identical to the one found in GitHub.
GitHub CLI
You should only need to run ./bin/vendor sail up -d and ./bin/vendor/sail npm run dev at the beginning and then run .bin/vendor/sail down at the end to close the locally hosted website. In addition, if you are facing additional issues with running the website, please see the FAQ: Operations.
When submitting a pull request to Github, please make sure that you have done the following:
- run
./vendor/bin/php-cs-fixer fixon the terminal - run
npm run eslint-fixon the terminal These two commands would correct some of the syntax within your code in addition to flag certain code to be reformatted in the proper notation