Merge branch 'develop' into header-footer

Author: vkguru

README.md

@@ -1,69 +1,65 @@
-barebones setup for JavaScript / Node projects replace this with a one-liner phrase describing this project or app
+trainings, certifications and employment opportunities for teachers
 
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/c2a6c9e610854e1da519d5eeab79df0d)](https://app.codacy.com/gh/BuildForSDG/EduKolab-Frontend?utm_source=github.com&utm_medium=referral&utm_content=BuildForSDG/EduKolab-Frontend&utm_campaign=Badge_Grade_Settings)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/c2a6c9e610854e1da519d5eeab79df0d)](https://app.codacy.com/gh/BuildForSDG/team-099-frontend?utm_source=github.com&utm_medium=referral&utm_content=BuildForSDG/team-099-frontend&utm_campaign=Badge_Grade_Settings)
-[![Codacy Badge](https://img.shields.io/badge/Code%20Quality-D-red)](https://img.shields.io/badge/Code%20Quality-D-red)
-
 
 ## About
-
-What is this project about. Ok to enrich here or the section above it with an image. 
-
-Once this repo has been setup on Codacy by the TTL, replace the above badge with the actual one from the Codacy dashboard, and add the code coverage badge as well. This is mandatory
-
-This is a simple JavaScript starter repo template for setting up your project. The setup contains
-
-- Jest: For runnung tests. We strongly recommend that JavaScript projects use Jest
-
-- Eslint & Prettier: For formatting code to match ESlint AirBnB coding standard. You might need to install the ESlint and Prettier plugins for your code editor to make the most of these utilities
+The name of our soolution is **EduKolab**.
+It is a web app that:
+- connects teachers in primary && secondary schools with international cooperations for training and certification as well as
+- offers trained & certified teachers to schools && guardians for employment
 
 ## Why
+The problem we set out to solve is that of 
+_**insuuficient supply of qualified teachers in your community, Nigeria, as well as other developing countries**_.
 
-Talk about what problem this solves, what SDG(s) and SGD targets it addresses and why these are imoirtant
+This project is geared at addressing the [4th Sustainable Developemnt Goal of Education](https://sustainabledevelopment.un.org/sdg4)
 
-## Usage
- How would someone use what you have built, include URLs to the deployed app, service e.t.c when you have it setup
+EduKolab aims particularly to improve the quality of education provided to primary && secondary school students by improving the quality of the teachers, the people who pass on this knowledge. 
+It is very important and relevant especially in this time for a good number of reasons notable among which are:
+- We will help create job employments for teachers that have been laid off because of the economic crises resulting from the Covid-19 pandemic
+- We will improve the quality of education in the country and hopefully Africa by improving the quality of knowledge && teaching methods employed by teachers to pass on knowledge
 
+## Usage
+URL to deployed staging-app is below
+[EduKolab Staging App](https://edukolab-staging-app.herokuapp.com/)
 
 ## Setup
-
-Install `npm` or `yarn` if you dont have any of them already installed. We recommend Yarn though.
-
-After clonning the repo to your local machine and moving into the cloned folder, Run `yarn install` to get started by installing dependencies. 
-
-`src/index.js` is the entry to the project and source code should go into the `src` folder.
-
-All tests should be written in the `__tests__' folder. There's a sample in there.
-
-This starter uses [Parcel](https://parceljs.org/getting_started.html) as the bundler. It is much simpler that WebPack and the others
+1. Clone repo `git clone https://github.com/BuildForSDG/EduKolab-Frontend.git edukolab`
+2. Verify npm global installation by running `npm install npm -g`
+3. Install dependencies by running `npm install` from the **edukolab** directory/folder
+3. Start app locally by running `npm run dev` from the **edukolab** directory/folder
 
 #### Hints
-
-- Run `npm install` or `yarn install` to get started. We'll assume you are using Yarn.
-- Install additional dependencies: `yarn add <dependency-name> [-D]`
-- Run tests: `yarn test`
-- Run tests with test coverage info: `yarn test:cover`
-- Check the codebase for proper syntax and formatting compliance: `yarn lint`
-- Run your app in local dev mode: `yarn start`. This puts the bundled app in a `dist` folder, set up a local web server at localhost:1234, and continues to watch for your code changes which it syncs with the local server. This means if you loaded the app in a browser, it will auto-refresh as you code along. Feel free to use whatever bundler best meets your needs. Parcel was only added as a sample and for those looking for a simple but effective solution to the hassle of bundlers. 
+1. Get Started: `npm install`
+2. Install additional dependencies: `npm install <dependency-name>`
+3. Run tests: `npm run test`
+4. Run tests in watch mode: `npm run test:watch`
+5. Run tests with test coverage info: `npm run test:cover`
+6. Check the codebase for proper syntax and formatting compliance: `npm run lint`
+7. Check the codebase for lint and test errors: `npm run check`
+8. Build app for deployment: `npm run build`
+9. Run app from build: `npm start`
+10. Run app in local dev mode: `npm run dev`. 
+- This first runs `npm run check` to check codebase for lint and test errors. If any are found, an npm error is thrown and the app exits with an error code
 
 ## Authors
 
-List the team behind this project. Their names linked to their Github, LinkedIn, or Twitter accounts should siffice. Ok to signify the role they play in the project, including the TTL and mentor
+    Sam Karis -- Team Mentor -- @sam-karis
+    Jedidiah Amaraegbu -- Technical Team Lead -- @amjedidiah
+    Victor Nwoguru -- Technical Communication Lead -- @vkguru
+    Philip Okonwanji -- @okonwanjiphilip
+    Hussein AbdulAzeez -- @lahkanmi
+    Yusuf AbdulAzeez -- @horler408
 
 ## Contributing
 If this project sounds interesting to you and you'd like to contribute, thank you!
-First, you can send a mail to [email protected] to indicate your interest, why you'd like to support and what forms of support you can bring to the table, but here are areas we think we'd need the most help in this project :
+First, you can send a mail to [email protected] copy [email protected] to indicate your interest, why you'd like to support and what forms of support you can bring to the table, but here are areas we think we'd need the most help in this project :
 1.  area one (e.g this app is about human trafficking and you need feedback on your roadmap and feature list from the private sector / NGOs)
 2.  area two (e.g you want people to opt-in and try using your staging app at staging.project-name.com and report any bugs via a form)
 3.  area three (e.g here is the zoom link to our end-of sprint webinar, join and provide feedback as a stakeholder if you can)
 
 ## Acknowledgements
 
-Did you use someone else’s code?
-Do you want to thank someone explicitly?
-Did someone’s blog post spark off a wonderful idea or give you a solution to nagging problem?
-
-It's powerful to always give credit.
-
 ## LICENSE
 MIT
-

app.properties

@@ -1,12 +1,100 @@
-project.name:
-project.repo:
-project.sdgs:
-project.app.url:
-project.codacy.url:
+# =========================================================================
+# this is a simple properties file
+# meant to curate important meta data
+# about what a team is building
+#
+# each entry should have a single value
+# or a list of comma separated values
+#
+# this file can be filled incrementally
+# since fields like app.urls (links to the deployed solutions)
+# might not have been created right now, so you can leave ot blank.
+#
+# the file should be at the rook of a repo
+# =========================================================================
 
-project.team.members:
-project.team.slackname:
 
-project.fb.opensource:
+# about the product
+# =================
 
-program.cohort:1
+# name of the product
+name:
+
+# what SDG goal(s) does the product solve
+sdgs:
+
+# name (not link) of repo
+repos:
+
+# URL(s) to the deplyed
+# app for the solution
+# e.g frontend UI app pr backend API
+app.urls:
+
+# URL(s) to the Codacy
+# dashbaord for this repo
+# e.g https://app.codacy.com/gh/BuildForSDG/farmify-frontend/dashboard
+codacy.urls:
+
+# YES if the solution
+# is solving for COVID-19
+# otherwise, NO
+app.forCOVID19: NO
+
+# what industries
+# does this solution
+# or its problem statement fall
+# under, e.g Agriculture
+# pick from this list : https://www.opensecrets.org/industries/alphalist.php
+app.industries:
+
+# about the codebase
+# ==================
+
+# what are the major
+# coding languages used
+# to create the solution
+code.languages:
+
+# what are the major
+# frameworks and libraries
+# used to create the solution
+code.frameworks:
+
+# what Facebook open source framework
+# library, tool, or platform API
+# is the codebase using
+code.opensource.facebook:
+
+# If the team created something
+# as a by-product of building the
+# product, and that something is now
+# open shource, pls list them
+code.opensource.contributions:
+
+# about the team
+# ==============
+
+# name of the team
+team.name:
+
+# github username
+# of the team's TTL(s)
+team.ttls:
+
+# github username
+# of the team's mentor(s)
+team.mentors:
+
+# name of the team's
+# Slak channel in the
+# BuildforSDG Slack
+# workspace
+team.slackchannel:
+
+# == DO NOT EDIT ==
+# about the program
+# =================
+program.cohort:1
+program.name:BuildforSDG
+program.community:https://github.com/BuildForSDG

public/humans.txt

@@ -5,7 +5,7 @@
 
     Sam Karis -- Team Mentor -- @sam-karis
     Jedidiah Amaraegbu -- Technical Team Lead -- @amjedidiah
-    Victor Nwoguru -- Technical Team Lead -- @vkguru
+    Victor Nwoguru -- Technical Communication Lead -- @vkguru
     Philip Okonwanji -- @okonwanjiphilip
     Hussein AbdulAzeez -- @lahkanmi
     Yusuf AbdulAzeez -- @horler408