skye8-tech / openFolio-v1-functional

0 stars 11 forks source link

Write Documentation for Setting Up and Running the Project Locally #21

Open andrew21-mch opened 3 months ago

andrew21-mch commented 3 months ago

Create documentation to guide users through the process of setting up and running the portfolio website on their local development environment. This includes installation instructions, configuration details, and usage guidelines.

Steps to Complete:

Write a README file that includes: Prerequisites for running the project (e.g., PHP, MySQL). Installation steps, including how to set up the database and configure environment variables. Instructions for running the project locally and any additional setup requirements. Ensure the documentation is clear and easy to follow for users with varying levels of experience.

Acceptance Criteria:

Comprehensive documentation is provided, allowing users to set up and run the project locally without issues. The documentation includes all necessary steps and troubleshooting tips.