Toolbox is a web application built using Laravel PHP framework and Vue.js for collecting suspect information. The aim of the project is to provide a platform to manage and store suspect information efficiently.
To get started with the development of Toolbox, follow the steps below:
-
Clone the repository:
git clone https://github.com/[YOUR_GITHUB_USERNAME]/toolbox.git -b develop
-
Install the dependencies:
composer install npm install
-
Set up the environment:
cp .env.example .env php artisan key:generate
-
Set up the database:
This project uses MySQL 8 as the preferred database. Create a database and update the .env file with the database credentials.
-
Migrate the database:
php artisan migrate
Contributions to the project are welcome. Follow the steps below to contribute:
- Clone the repository:
git clone https://github.com/[YOUR_GITHUB_USERNAME]/toolbox.git -b develop
- Create a new branch with a descriptive name for the changes you want to make:
git checkout -b feature/[YOUR_BRANCH_NAME]
- Make your changes and commit with a descriptive message:
git add . git commit -m "Add a detailed commit message"
- Push your changes to the repository:
git push origin feature/[YOUR_BRANCH_NAME]
- Create a pull request to the develop branch with a detailed description of the changes you made and the reasons for making them.
The QA site for the project is located at qa.toolbox.co.ug and the production site is located at toolbox.co.ug. The deployment process should be handled by the project maintainers.
The following software is required to develop and run Toolbox:
- PHP 8.1
- MySQL 8
- Composer
- Node.js and npm
- Laravel - The PHP framework used
- Vue.js - The JavaScript framework used
The project is licensed under the MIT License.