Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
andrew21-mch opened this issue Aug 16, 2024 · 0 comments
Open
Assignees
Labels

Comments

@andrew21-mch
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

No branches or pull requests

2 participants