{"id":18683557,"url":"https://github.com/scify/mentorship-matching-backend","last_synced_at":"2025-04-12T04:31:46.108Z","repository":{"id":16889779,"uuid":"80817768","full_name":"scify/Mentorship-matching-backend","owner":"scify","description":"Job-Pairs is an online tool, designed to help university graduates to successfully (re-)enter  the labor market.","archived":false,"fork":false,"pushed_at":"2025-02-16T08:13:46.000Z","size":7263,"stargazers_count":8,"open_issues_count":0,"forks_count":3,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-26T00:05:43.386Z","etag":null,"topics":["composer","css","gulp","html","laravel","laravel-application","laravel-framework","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scify.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-03T10:05:30.000Z","updated_at":"2025-02-16T08:13:47.000Z","dependencies_parsed_at":"2023-10-16T20:58:26.081Z","dependency_job_id":"ceaeb92a-522b-4538-a7a8-3b29123b3895","html_url":"https://github.com/scify/Mentorship-matching-backend","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scify%2FMentorship-matching-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scify%2FMentorship-matching-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scify%2FMentorship-matching-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scify%2FMentorship-matching-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scify","download_url":"https://codeload.github.com/scify/Mentorship-matching-backend/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248517190,"owners_count":21117411,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["composer","css","gulp","html","laravel","laravel-application","laravel-framework","php"],"created_at":"2024-11-07T10:14:56.412Z","updated_at":"2025-04-12T04:31:41.725Z","avatar_url":"https://github.com/scify.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mentorship matching backend platform\n\nThis [Laravel](https://laravel.com/docs/8.x/) application is a platform backoffice that manages the matching process\nbetween mentors with mentees, based on their\npreferences and skills.\n\n## Table of Contents\n\n- [First time install](#first-time-install)\n    - [Docker option (recommended)](#docker-option-recommended)\n    - [Non-Docker option](#non-docker-option)\n        - [Installing dependencies (assuming apache as web server and mysql as db):](#installing-dependencies-assuming-apache-as-web-server-and-mysql-as-db)\n            - [Frontend dependencies](#frontend-dependencies)\n            - [Backend dependencies](#backend-dependencies)\n            - [Composer installation](#composer-installation)\n            - [Apache configuration:](#apache-configuration)\n            - [Laravel local server](#laravel-local-server)\n- [Setup the Database](#setup-the-database)\n- [Add seed data to DB](#add-seed-data-to-db)\n- [Building the project](#building-the-project)\n- [Compiling assets](#compiling-assets)\n- [Contributing](#contributing)\n- [License](#license)\n- [Credits](#credits)\n\n## First time install\n\nAfter cloning the project, create an `.env` file (should be a copy of `.env.example`),\ncontaining the information about your database name and credentials.\n\n```bash\ncp .env.example .env\n```\n\n### Docker option (recommended)\n\nYou can use the `docker-compose.yml` file that exists at project root, to quickly set up a docker container.\n\nTo build the docker container, run:\n\n```bash\ndocker compose build\n```\n\nAnd then run\n\n```bash\ndocker compose up\n```\n\nTo fire up the container.\n\nThen, you can enter the container by running\n\n```bash\ndocker exec -it mentorship_matching_platform_server bash\n```\n\nAnd from there, you can run all the `php artisan`, `composer`, and `npm` commands.\n\n### Non-Docker option\n\n#### Installing dependencies (assuming apache as web server and mysql as db):\n\nIn a nutshell (assuming debian-based OS), first install the dependencies needed:\n\n##### Frontend dependencies\n\nNote: Please install the node and npm versions as listed below:\n\n```bash\n$ node -v\nv14.21.3\n\n$ npm -v\n6.14.18\n```\n\nIf using NVM, you can install the correct versions by running:\n\n```bash\nnvm use # reads the .nvmrc file and installs the correct node and npm versions\n```\n\n#### Backend dependencies\n\nNote: php package installs apache2 as a dependency so we have no need to add it manually.\n\n```bash\nsudo aptitude install php7.4 php7.4-cli mcrypt php7.4-mcrypt mysql-server php7.4-mysql\n```\n\n##### Composer installation\n\nInstall composer globally by following the instructions [here](https://getcomposer.org/download/).\n\n##### Apache configuration:\n\nEdit the `/etc/apache2/sites-available/mentorhsip-matching.conf` so that it looks like:\n\n```text\n\u003cVirtualHost *:80\u003e\n    ServerName dev.mentorhsip-matching\n    DocumentRoot \"/path/to/Mentorship-matching-backend/public\"\n    \u003cDirectory \"/path/to/Mentorship-matching-backend/public\"\u003e\n        AllowOverride all\n    \u003c/Directory\u003e\n\u003c/VirtualHost\u003e\n```\n\nMake the symbolic link:\n\n```bash\ncd /etc/apache2/sites-enabled \u0026\u0026 sudo ln -s ../sites-available/mentorhsip-matching.conf\n```\n\nEnable `mod_rewrite` and restart the server:\n\n```bash\nsudo a2enmod rewrite \u0026\u0026 sudo service apache2 restart\n```\n\nFix permissions for storage directory:\n\n```bash\nsudo chown -R user:www-data storage\nchmod 775 storage\ncd storage/\nfind . -type f -exec chmod 664 {} \\;\nfind . -type d -exec chmod 775 {} \\;\n```\n\nTest the setup by navigating to `http://dev.mentorhsip-matching` in your browser.\n\n##### Laravel local server\n\nYou can also test your setup by running the Laravel local server:\n\n```bash\nphp artisan serve\n```\n\nand navigating to [localhost:8000](http://localhost:8000).\n\n## Setup the Database\n\nLaravel provides a simple yet powerful mechanism for creating the DB schema,\ncalled [Migrations](https://laravel.com/docs/6.0/migrations)\nSimply run ```php artisan migrate``` to create the appropriate DB schema.\n\n### Add seed data to DB\n\nRun ```php artisan db:seed``` in order to insert the starter data to the DB by\nusing [Laravel seeder](https://laravel.com/docs/6.0/seeding)\n\n## Building the project\n\nDownload all Laravel dependencies through [Composer](https://laravel.com/docs/6.0/installation), by running\n\n```bash\ncomposer install\n\ncomposer update\n```\n\nAfter all Laravel dependencies have been downloaded, it's time to download all Javascript libraries and dependencies.\nWe achieve that by using [npm](http://blog.npmjs.org/post/85484771375/how-to-install-npm).\nRead [this](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-an-ubuntu-14-04-server) link in\norder to understand how npm should be installed.\n\nIf you prefer installing npm through [homebrew](http://brew.sh/) or [linuxbrew](http://linuxbrew.sh/),\nread [this](http://blog.teamtreehouse.com/install-node-js-npm-linux).\n\nSo, when in project root directory, and after npm has been installed correctly, run\n\n```bash\nnpm install\n```\n\nTo download and install all libraries and dependencies.\n\n## Compiling assets\n\nWhen in project root directory, run\n\n```bash\nnpm run dev\n```\n\nOr any other `npm` script that you want to run. The available scripts are listed in the `package.json` file.\n\n## Contributing\n\nTo contribute to MyEIC Common Library, follow these steps:\n\n1. Fork this repository.\n2. Read the [CONTRIBUTING](CONTRIBUTING.md) file.\n3. Create a branch: `git checkout -b \u003cbranch_name\u003e`.\n4. Make your changes and commit them: `git commit -m '\u003ccommit_message\u003e'`\n5. Push to the original branch: `git push origin \u003cproject_name\u003e/\u003clocation\u003e`\n6. Create the pull request.\n\n## License\n\nThis project is open-sourced software licensed under\nthe [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).\n\n## Credits\n\nIcons used in this project are made by\n\n- [Freepik](http://www.flaticon.com/authors/freepik) from [www.flaticon.com](http://www.flaticon.com)\n- [Vectors Market](http://www.flaticon.com/authors/vectors-market) from [www.flaticon.com](http://www.flaticon.com)\n- [Prosymbols](http://www.flaticon.com/authors/prosymbols)  from [www.flaticon.com](http://www.flaticon.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscify%2Fmentorship-matching-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscify%2Fmentorship-matching-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscify%2Fmentorship-matching-backend/lists"}