Welcome to Project Planner, a dynamic project management web application! It's built using Vue 3 for the frontend and PHP for the backend, creating a seamless single-page application experience. The frontend communicates with the backend via API calls, which are processed and interacted with the database by the backend.
Project Planner allows you to manage your projects effectively. Here's what you can do:
- π Create an account: Get started by creating your own account.
- π View a list of projects: See all your projects in one place.
- π Filter the list of projects: Easily find the projects you need based on their status.
- β Add a project: Start new projects with ease.
- βοΈ Edit a project: Make changes to your projects as needed.
- ποΈ Delete a project: Remove projects that are no longer needed.
- π Change the status of a project: Keep track of your progress by updating the status of your projects.
- π Set due dates: Plan your schedule by setting due dates for projects, which will show up to remind you.
The frontend, located in the frontend/ directory, is built with Vue 3 and Vite, and styled with Tailwind CSS. The source code is located in the src/ subdirectory.
To get started with the frontend:
- Navigate to the
frontend/directory - Run
npm installto install the necessary dependencies - Start the development server with
npm run dev - To build the application for production, run
npm run build
For more detailed instructions, please refer to the frontend README.
The backend, located in the backend/ directory, is built with PHP and uses Docker for containerization. The source code is located in the app/ subdirectory, which contains various PHP classes for controllers, models, and services.
To get started with the backend:
- Navigate to the
backend/directory - Run
docker compose upto start the Docker containers
For more detailed instructions, please refer to the backend README.
The project uses GitHub Actions for continuous integration and deployment. There are two workflows: one for the frontend and one for the backend. These workflows are triggered on push to the main branch and deploy the application to a web server. The workflows are defined in the .github/workflows/ directory.