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

Updated the README #1

Merged
merged 1 commit into from
Aug 16, 2024
Merged

Updated the README #1

merged 1 commit into from
Aug 16, 2024

Conversation

fakegithub01
Copy link
Owner

Description

This pull request updates the instructions in the README file for running the AOSSIE website locally. The previous instructions were unclear regarding the commands needed to install dependencies and start the development server. This update aims to improve clarity and ensure that contributors can set up the project without confusion.

Changes Made

  • Revised the "Running the website Locally" section to explicitly state the commands for:
    • Installing the required dependencies using npm install.
    • Starting the development server with npm run dev.

Why This Change

The original instructions were somewhat ambiguous and could lead to confusion for new contributors. Clear and precise instructions are essential for an effective setup process and to ensure that contributors can get the development environment running smoothly.

Additional Notes

Please review the updated README file to ensure that all instructions are accurate and easy to follow. Let me know if any further adjustments are needed.

Related Issues

Resolves: AOSSIE-Org/website issue AOSSIE-Org#238

@fakegithub01 fakegithub01 merged commit df7a449 into main Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant