dev-seahouse / cs3226assignments Goto Github PK

rankteam1

HTML 2.13% JavaScript 94.38% PHP 3.45% ApacheConf 0.02% Vue 0.01% Batchfile 0.01%

cs3226assignments's Introduction

Ranklist - Lab 6

Hello, if you thought of something that need to done, but busy at the moment, create an issue! So that somebody who might find the problem doable/easy can get that job done instead! Remember to describe the problem and the definition of done as clearly as possible, just suggesting~

User accounts

[email protected] (admin)
[email protected] (admin)
[email protected] (admin)
[email protected] (admin)
[email protected] (admin)
[email protected] (admin)
[email protected] (student Husky)
[email protected] (student Chopper)

DEFAULT PASSWORDS: qwerty123

Database Structure

Setup guide

XAMPP setup

Install XAMPP

https://www.apachefriends.org/index.html

Clone the project into C:\xampp\htdocs\rankteam1

git clone https://github.com/dev-seahouse/cs3226Assignments.git

Configure Virtual Host

Add the following code into C:\xampp\apache\conf\extra\httpd-vhosts.conf

<VirtualHost *:80>
    DocumentRoot "C:\xampp\htdocs\rankteam1\public"
    Errorlog "C:\xampp\htdocs\rankteam1\storage\logs\error.log"
    <Directory "C:\xampp\htdocs\rankteam1\public">
        Options Indexes FollowSymLinks 
        AllowOverride All 
        Require all granted         
    </Directory>
</VirtualHost>

Setup Laravel

Setup requirements to install composer

Remove the semi-colon for the following values in C:\xampp\php\php.ini

extension=php_openssl.dll
extension=php_curl.dll
extension=php_sockets.dll

double check that there is only one uncommented line of "extension=php_openssl.dll"

Install Composer

Download and install Composer at https://getcomposer.org/download/
When asked to select command-line PHP, browse to C:\xampp\php\php.exe

Install Laravel

In the root folder of the project C:\xampp\htdocs\rankteam1 open command prompt and run the following commands:

# composer global require "laravel/installer"
# composer install
# composer require "laravelcollective/html":"^5.3.0"

Generate .env file

In the root folder of the project C:\xampp\htdocs\rankteam1

# php artisan config:clear
# copy .env.example .env
# php artisan key:generate

Use the server's database for the project

Modify the following settings in C:\xampp\htdocs\rankteam1\.env

DB_CONNECTION=mysql
DB_HOST=128.199.205.219
DB_PORT=3306
DB_DATABASE=ranklist
DB_USERNAME=developer
DB_PASSWORD=developerP@ssw0rd1

Access the server's database through the web browser

Update the following variables in C:\xampp\phpMyAdmin\config.inc.php

$cfg['Servers'][$i]['auth_type'] = 'config';
$cfg['Servers'][$i]['user'] = 'developer';
$cfg['Servers'][$i]['password'] = 'developerP@ssw0rd1';
$cfg['Servers'][$i]['host'] = '128.199.205.219';

You should be able to access http://localhost/phpmyadmin without having to enter the credentials

To access http://128.199.205.219/phpmyadmin/
User: developer
Password: developerP@ssw0rd1

Setup mailgun

In the root folder of the project C:\xampp\htdocs\rankteam1 open command prompt and run the following command:

# composer require guzzlehttp/guzzle

Modify the following settings in C:\xampp\htdocs\rankteam1\.env Verified Mailgun domain settings

MAIL_DRIVER=smtp
MAIL_HOST=smtp.mailgun.org
MAIL_PORT=2525
[email protected]
MAIL_PASSWORD=89655d866e35092485fe34b412474103
MAIL_ENCRYPTION=null

Sandbox credentials: MAIL_USERNAME=[email protected] MAIL_PASSWORD=a0c542a3057fc62deff7e1e10016f18b

Install NodeJS

Download and install Nodejs at https://nodejs.org/en/
open command prompt and run the following commands:

# npm install

Launch local development server

If you are using windows, open command prompt and type the following command

# .\run

If you are using linux/Mac, open terminal and type the following command

# php artisan serve & npm run watch

Compile front end assets manually (css and javascript)

Open terminal and type the following command:

npm run production

cs3226assignments's People

Contributors

Watchers

cs3226assignments's Issues

extra C - localization (chinese?)

extra E - add facebook like button / twitter tweet button

Create new view for read/write messages by students/admins

Create new Achievement view to display many to many relations with Student

achievements table in database will give you the following:

title
max_points (number of stars)
description

use the information to do, for example: (this achievement's max points is 6)
****** Kattis apprentice: Be in top 25 (6%)/50 (5%)/100 (4%)/150 (3%)/200 (2%)/250 (1%) of Kattis ranklist by the end of Week13 (this achievement will NOT be updated weekly as this will keep changing every week).

create methods in controller and views to successfully display records in landing page

edit by components

create appropriate methods in models to retrieve the following data (in reasonable delay)

{
Flag => "SG",
Name=>"name",
Katitis=>"",
propic=>"",
MC=>"",
TC=>"",
SPE=>"",
HW=>"",
Bs=>"",
KS=>"",
Ac=>"",
DIL=>"",
Sum=>"",
}
something like this
select students.flag, students.name,components.score_sum, students.katits etc
from students join components on students.id = components.student_id
join scores on scores.component_id = components.id
group by students.id
order by components.score_sum desc

create student: add validation for nationality. allow jpg/gifs?

use http://flag-icon-css.lip.is/ to display flags based on 2 letter country code

try to change the default email template. Try to use own app name in header

return error status code if fail validation/ajax

Apply Page Controller design pattern

extra b - performance and scalability (test 10000 students, optimize if lag)

edit student mode should have components broken down into multiple text fields with validation

current:

MC:
0,0,0,0,0,0,0,0,0,0,0,0

split these components input up, similar to team 3's implementation.
make each of it a text field, not number input type because 'x' 'x.y' 'xy.z' are allow values.

find out why achievement page prompts for french translate, and fix it!

create student: in-line image editing

benefits: less painful if the image exceeds size limit

can try this for image editing, or any other libraries
https://mattketmo.github.io/darkroomjs/

If completed, allow editing of image on edit page too. Check if #26 is completed

On accessing unavailable routes (HTTP error 404), or any other non HTTP 200 responses, give a more graceful error message

From non-index page, hover over brand name(cs3233 ranklsit 2017) looks weird. intentional highlight?

edit student: allow editing of nationality; upload new profile pic

When uploading profile pic is completed, remember to update profile_pic logic on controller.

note the file extensions (use delete old_pic, create new_pic, instead of renaming)

If #25 is completed, allow editing of image too

create
edit
edit by component
login (not sure if laravel done for us)
forget password (not sure if laravel done for us)
password reset (not sure if laravel done for us)

Use built-in timestamps feature in Laravel Eloquent ORM to display time-related information, e.g. the ranklist is last updated ['X days ago' or 'on Monday, 13 February 2017, 9.58pm SGT']..., etc.

achievements: allow add/edit/delete. See comments for details

linked to #14
not a requirement (similar to listing from db), but our database structure can easily support this

http://codepen.io/ashblue/pen/mCtuA

can use the above link or any js libraries that looks nice / easy to implment