Amirhf1 / challenge

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Challenge

Table of Contents

Project Description

suppose in a sample system, each employee has two user roles (registrant and reviewer) and the system is supposed to assign a document to a person based on priority and creation time.

Features

  • After the time of appointment, another person does not have access to it for registration and inspection purposes
  • After the end of the appointment period, if the status of the document does not change to registration and verification, it will return to the post-appointment cycle (basic status)
  • The employee can withdraw from the appointment that has been given and that document can no longer be viewed for review or registration.

Installation

1.Clone the repository:

git clone https://github.com/Amirhf1/challenge

2.Navigate to the project directory:

cd challenge

3.Install the dependencies using Composer:

composer install

4.Configure the environment variables by renaming the .env.example file to .env and updating the necessary values (database, mail, etc.).

5.Generate the application key:

php artisan key:generate

6.Run the database migrations:

php artisan migrate

7.Start the development server:

php artisan serve

8.The application should now be accessible at http://localhost:8000.

Install with Docker

Clone repository and go to repository directory

cp .env.example .env

composer i

docker-compose build

make up

Running Tests

To run tests, run the following command

make test 

Code coverage report (HTML)

make html 

Code Style

Improve code style with laravel/pint

Show the parts that have problems

make pint-test 

Fix the parts that have problems

make pint  

Contributing

Specify how others can contribute to your project. You can include guidelines for reporting issues, submitting feature requests, or making pull requests. Mention any coding conventions, standards, or guidelines that contributors should follow. Provide instructions for setting up the development environment and making contributions.

License

Indicate the license under which your project is distributed. For example:

This project is licensed under the MIT License.

You can customize the sections and content of the `README.md` file based on your project's specific needs. Make sure to provide clear instructions and relevant information to help users understand and use your project effectively.

About


Languages

Language:PHP 74.8%Language:Blade 23.3%Language:Makefile 0.9%Language:Dockerfile 0.7%Language:JavaScript 0.2%