nartehi / ticfoundation

0 stars 0 forks source link

TiC Foundation

Overview

TiC Foundation is a non-profit website aimed at providing underprivileged young students in rural towns of Ghana with resources to learn basic computer skills. This React-based platform serves as a hub for educational materials, interactive lessons, and community support to bridge the digital divide and empower students for a better future.

Features

Tech Stack

Getting Started

Prerequisites

Contributing To UI

  1. Clone the repository:

    
    git clone https://github.com/nartehi/TiC-Foundation.git
  2. Create a branch before start developing:

    
    git branch issue_number
    
    e.g issue1-datePicker
  3. Change directory into app-ui:

    
    cd app-ui
  4. Install npm:

    
    npm i or npm install
    Please only run this when you are prompted to otherwise do not run it
  5. Starts the development server:

    
    npm start  or npm run-script start  
  6. Install UI framework:

    
    npm install @material-ui/core
  7. Start the test runner:

    
    npm test
  8. To create a production build:

    
    npm run build.
  9. Removes this tool and copies build dependencies, configuration files and scripts into the app directory. If you do this, you can’t go back!

    
    npm run eject
  10. Bundles the app into static files for production.

    
    npm run build 
    10. If you have issues with build, install the following fonts:
    ```bash
    npm install --save @fortawesome/fontawesome-svg-core
    npm install --save @fortawesome/free-solid-svg-icons
    npm install --save @fortawesome/free-brands-svg-icons
    npm install --save @fortawesome/react-fontawesome
    npm install react-scroll
    npm install react-router-dom
    npm install react-router-dom

To See Latest Changes From Develop branch in your branch

Steps:

  1. Checkout dev branch (git checkout develop)
  2. Get the latest of develop branch (git pull)
  3. Checkout branch your_branch (git checkout your_branch)
  4. Merge develop branch to branch your_branch (git merge develop)