lintrieu / cfg-volunteer-portal Goto Github PK

1.0 2.0 0.0 522 KB

Social portal for CodeFirstGirls volunteer instructors to log their hours against the relevant CFG course/session.

Shell 1.00% PHP 77.81% Blade 19.99% Makefile 1.21%

php laravel mysql mvc-architecture codefirstgirls heroku

cfg-volunteer-portal's Introduction

CodeFirst:Girls Volunteer Portal

Purpose: A platform to enable CFG instructors to log & record their volunteering hours.

Scaffold & Set-Up

Laravel 8 application scaffold
Authentication scaffold
Set up local mySQL database
Makefile set up
Integrate social log in
Composer download front-end dependencies, such as CSS Bootstrap and jQuery libraries
Heroku set up
TravisCI set up

Set up the Objects - migration, models, factory, seeders

The application is pre-configured with two user accounts for varying user permission levels.

Password for both user accounts: password

Git clone repository,
Install PHP, mySQL, Composer, and GNU's Make software.
Set up a local mySQL database named cfg_volunteers (details below)
Run the command make migrate-seed to run database migrations and seeders,
Compile CSS UI resources by running npm install, and build dev assets running npm run dev ,
Run make start to start the server. View application on your localhost.

See Makefile for a list of commands available in the application.

Install the mySQL client.
Run the mySQL client - $ mysql -u root -p
- -u - user flag
- root - database user login
- -p - password flag. You will be prompted to enter a password. Submit enter, with a blank password.
Create a local database the application can interact with: CREATE DATABASE cfg_volunteers;
- Run the query SHOW DATABASES;, to confirm your database has been created.
In the .env file (line 9-15), update the Database Connection config to match the database you configured locally.
- DB_CONNECTION, DB_HOST, DB_PORT - you should not have to update these,
- DB_DATABASE - update with the name of your Database (e.g. cfg_volunteers),
- DB_USERNAME, DB_PASSWORD - represent your personal mySQL user credentials.
Once your .env config is setup, run make migrate to verify your Database connection and run migrations.