Giter VIP home page Giter VIP logo

toolbox's Introduction

Toolbox

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.

Getting Started

To get started with the development of Toolbox, follow the steps below:

  1. Clone the repository:

    git clone https://github.com/[YOUR_GITHUB_USERNAME]/toolbox.git -b develop
    
  2. Install the dependencies:

    composer install
    npm install
    
  3. Set up the environment:

    cp .env.example .env
    php artisan key:generate
    
  4. 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.

  5. Migrate the database:

    php artisan migrate
    

Contribution

Contributions to the project are welcome. Follow the steps below to contribute:

  1. Clone the repository:
    git clone https://github.com/[YOUR_GITHUB_USERNAME]/toolbox.git -b develop
    
  2. Create a new branch with a descriptive name for the changes you want to make:
    git checkout -b feature/[YOUR_BRANCH_NAME]
    
  3. Make your changes and commit with a descriptive message:
    git add .
    git commit -m "Add a detailed commit message"
    
  4. Push your changes to the repository:
    git push origin feature/[YOUR_BRANCH_NAME]
    
  5. Create a pull request to the develop branch with a detailed description of the changes you made and the reasons for making them.

Deployment

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.

Prerequisites

The following software is required to develop and run Toolbox:

  1. PHP 8.1
  2. MySQL 8
  3. Composer
  4. Node.js and npm

Built With

  1. Laravel - The PHP framework used
  2. Vue.js - The JavaScript framework used

License

The project is licensed under the MIT License.

toolbox's People

Contributors

jshgwng avatar jj4696640 avatar

Watchers

 avatar

toolbox's Issues

Storing and tracking suspect information

As an officer, I want to be able to enter and store suspect information, including personal details, photographs, and criminal records in the system so that I can keep track of the suspects.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.