Skip to content

improve README with local setup and project structure #6

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.

Sign up for GitHub

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

Open
mansuriaftabmfd wants to merge 1 commit into
base: main
Choose a base branch
from
Open

improve README with local setup and project structure #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,23 @@ Contributions to the GO Web Store and its underlying technology are welcome! To
3. Open a pull request with your changes.

---
## 🛠️ Local Development Setup
1. Fork the project.
2. Clone your fork: `git clone https://github.com/your-username/GO-Web-Store.git`
3. Open `index.html` in your browser (Live Server extension in VS Code is recommended).

## 📂 Folder Structure
- `assets/`: Images and media.
- `js/`: Application logic and PWA service workers.
- `index.html`: Main landing page.
- `manifest.json`: PWA configuration.

## 🤝 Contribution Guidelines
1. Pick an issue or create one.
2. Create a feature branch: `git checkout -b feature-name`.
3. Commit your changes: `git commit -m "Description of changes"`.
4. Push to your fork and open a Pull Request.


## Acknowledgments

Expand Down