abdelghani1002/Taskify-API

TASKIFY-API

Developed with the software and tools below.

---

🚀 Getting Started

Requirements

Ensure you have the following dependencies installed on your system:

• PHP: version 8.2.*
• Composer: version 2.7.*

⚙️ Installation

1. Clone the Taskify-API repository:

git clone https://github.com/abdelghani1002/Taskify-API

2. Change to the project directory:

cd Taskify-API

3. Install the dependencies:

composer install

npm install

4. Generate key

php artisan key:generate

5. Setup .env file:

cp .env.example .env

6. Setup database

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE="DB name"
DB_USERNAME="username"
DB_PASSWORD="password"

🤖 Running Taskify-API

Use the following command to run Taskify-API:

php artisan serve

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.
• Report Issues: Submit bugs found or log feature requests for Taskify-api.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your GitHub account.
2. Clone Locally: Clone the forked repository to your local machine using a Git client.

git clone https://github.com/abdelghani1002/Taskify-API

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

git commit -m 'Implemented new feature x.'

6. Push to GitHub: Push the changes to your forked repository.

git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.