diff --git a/Documentation.md b/Documentation.md new file mode 100644 index 00000000..277f6155 --- /dev/null +++ b/Documentation.md @@ -0,0 +1,72 @@ +# Setting up CIEF Exchange onto your local machine + +## Prerequisite: + +📌:Pre-requisites +- **NodeJS version 14** +- **Xampp** +- **Laravel** + +## Setting up: + +1. Clone GitLab into Visual Studio Code + +2. Rename ``.env.example`` to ``.env``. If you're sentimental just make another copy and rename the copy. + +3. Open Terminal and run after installing Composer + + ``` + composer install --ignore-platform-reqs + ``` + +4. Next is setting up your database. Naviagate to ``.env`` and name CIEF Portal Database. Example: + + ``` + DB_CONNECTION=mysql + DB_HOST=127.0.0.1 + DB_PORT=3306 + DB_DATABASE=exchange_db <------ Here + DB_USERNAME=root + DB_PASSWORD= + ``` + +5. Open Xampp, navigate to phpmyadmin then Create a new Database in phpmyadmin with the same name as the name you named it + +6. Migrate the database to inherit all the tables from the cloned repository by using these command in the terminal: + + ``` + php artisan migrate + ``` + ``` + php artisan migrate:fresh --seed + ``` + +7. Once done you can check phpmyadmin if the database is properly migrated. + +8. Next is setting up the frontend. Assuming you already have nodejs ver14(Specifically) installed, run this in the terminal + + ``` + npm install + ``` + +9. Next we install gulp with this command + + ``` + npm install -g gulp + ``` + +10. Now we build gulp with this command + + ``` + gulp build + ``` + +11. You are all set to view this project/repository locally. To run them run these command in 2 seperate terminals + + ``` + php artisan serve + ``` + + ``` + npm run watch OR npm run dev + ``` diff --git a/resources/assets/vue/components/general/elements/RemarkComponent.vue b/resources/assets/vue/components/general/elements/RemarkComponent.vue index 4825c088..adf0cf02 100644 --- a/resources/assets/vue/components/general/elements/RemarkComponent.vue +++ b/resources/assets/vue/components/general/elements/RemarkComponent.vue @@ -5,6 +5,9 @@