How to setup project on your local:

First of all you need to ask for access. you need to provide you github account email or user to your manger.

You will receive notification on github and your email address to access the repository. After accepting you will have the access to project repository.

Now by following the step given below you can successfully setup the project on your local machine.

1. Download the code form github repo.
2. move the files to your local server i.e wamp or xampp in a directory.
3. extract the files. file must be in your project root directory.

Attach Your Local Project with online repo:

Navigate to project folder run the following command in treminal or cmd

• git add .
• git commit -m “Commit”
• git remote add origin link to online repository i.e git remote add origin https://github.com/mazajnet/repo_name.git
• git fetch origin
• git checkout -m main

Configure  and Run Project:

1. Go to project directory
2. copy .example.env to a new file named as .env
3. run composer install
4. run npm install
5. frun npm run dev (and  For School master: npm run build​)
6. change the following variable in env file :
   

   APP_NAME=//project name
   APP_ENV=local
   APP_DEBUG=true
   DEBUGBAR_ENABLED=false
   
   APP_DIR=//project directory
   APP_URL="http://localhost/${APP_DIR}" //dont change it
   LIVEWIRE_ASSET_URL="/${APP_DIR}" //dont change it
   
   // Only for uniranks 
   
   REGISTER_MAIN_ROUTES=// set it true if you are working on main side other must be false
   REGISTER_ADMIN_ROUTES=// set true if you are working on university admin others must be false
   REGISTER_COMMITTEE_ROUTES=// set true if you are working on committee others must be false
   REGISTER_SUPER_ADMIN_ROUTES=// set true if you are working on super admin true others must be false
   REGISTER_ACADEMIC_ROUTES=// set true if you are working on academic others must be false
   // end only for uniranks
   
   DATABASE_NAME, 
   DATABASE_USERNAME
   DATABASE_PASSWORD
   
   LOG_CHANNEL=single
   
   // To fill the mail configuration use mail trap if needd
   MAIL_MAILER=
   MAIL_HOST=
   MAIL_PORT=
   MAIL_USERNAME=
   MAIL_PASSWORD=
   MAIL_ENCRYPTION=
   MAIL_FROM_ADDRESS=
   MAIL_FROM_NAME="${APP_NAME}"
   MAIL_OWNER_EMAIL=
   
   AWS_ACCESS_KEY_ID=//ASK From Manager
   AWS_SECRET_ACCESS_KEY=//ASK From Manager
   AWS_DEFAULT_REGION=//ASK From Manager
   AWS_BUCKET=//ASK From Manager​

Data Base:

You must ask for database from manager. He'll provide you database according your project.

if you are working uniranks. just run php artisan:migrate --seed  and you are good to go.

Run project:

Dont user php artisan serve command. all of our projects are configured to run directly in browser with out serve command.

i.e http://127.0.0.1/ranking