Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 3.7 KB

README.md

File metadata and controls

60 lines (36 loc) · 3.7 KB
Raw

VLab for Science and Engineering

Vlab is a platform that intends to enable equitable virtual access, tools and near-real life experience of conducting basic science and engineering based experiments that have otherwise become difficult to be carried out by ALL first year or second-year science and engineering students in the laboratory within the semester period. This project is currently supported by the Royal Academy of Engineering under the Higher Education Partnerships in sub-Saharan Africa scheme (HEP-2021-129)

Vlab will be standing on the shoulder of technology giants such as Laravel, Vue js and Bootstrap for development.

Dependencies

To use this project, you will need to set up your system for development with laravel 7. Check out this Link if you don't have laravel setup on your system.

Installation

With Laravel and of course git setup on your system, follow the below steps:

  • Clone this repo by entering git clone https://github.com/cs-dept-ibbul/vlab.git into your terminal.
  • Enter your newly cloned project directory using cd vlab.
  • Create a file named .env file and copy the contents of the .env.example into the new .env file or alternatively rename the .env.example file to .env.
  • Run composer install then php artisan key:generate on your terminal/command prompt to generate a secured key for your project as well as download the project dependencies.
  • Run yarn install && yarn watch or npm install && npm run watch to install the frontend dependencies.
  • Run php artisan serve to spin up the development server.

Check out this link to understand the folder structure. PS: Frontend codes reside in /resources/js

How to test the software

Follow the installation guide to test this software.

Getting involved/Contributing

There are two primary ways to help:

  • Using the issue tracker, and
  • Changing the code-base.

Using the issue tracker

Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in the issue that you will take on that effort, then follow the Changing the code-base guidance below.

Changing the code-base

Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull request detailing what issue you are solving. All new code should follow our stylistic and architectural setup already exhibited by the project.This basically means all new contributions must mimic the styles and patterns in the single code-base.

This project will be adopting the Udacity Git Commit Message Style, Check Here for guidance

License

VLab is licensed under the MIT License.

Sponsors

RAE Logo_Black_RGB We acknowledge initial pilot support from the Royal Academy of Engineering (RAEng), United Kingdom under the Higher Education Partnership in Sub-Saharan Africa (HEP-SSA), Project Reference: HEP/2021/129

Partners

This project is co-design and developed with faculties from IBB University, Lapai, Baze University, Abuja, and Scientific Equipment and Development Institute, Minna.

For further enquiries, please email Project Lead, Abdullahi via [email protected] or [email protected]