Skip to content

docs: add Getting Started section #115

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
dahlinomine wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Getting Started section #115

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
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,22 @@ This is the website for wwebjs.dev and the guide for the [whatsapp-web.js](wwebj
* [GitHub][gitHub]
* [npm][npm]

## Getting Started

To run this website locally for development:

1. Clone the repository: `git clone https://github.com/wwebjs/wwebjs.dev.git`
2. Install dependencies: `npm install`
3. Start the development server: `npm run dev`
4. Open your browser at `http://localhost:8080`

## Contributing

Everyone is welcome to contribute to this guide and help us improve it. Please take a moment to review the [guidelines for contributing][contributing] first, befor creating a pull request. Don't rush a contribution, test changes locally, make sure you're doing it correctly and then submit a pull request. Ideas for you first contribution can be found in the issue label [good first issue][good-first-issue] or in the [To-Do section][todo].
Everyone is welcome to contribute to this guide and help us improve it. Please take a moment to review the [guidelines for contributing][contributing] first, before creating a pull request. Don't rush a contribution, test changes locally, make sure you're doing it correctly and then submit a pull request. Ideas for you first contribution can be found in the issue label [good first issue][good-first-issue] or in the [To-Do section][todo].

## Help

If you experiencing issues with the guide in understaning, please open an issue or ask on [Discord][discord] for help.
If you experiencing issues with the guide in understanding, please open an issue or ask on [Discord][discord] for help.

[wwebjs]: https://github.com/pedroslopez/whatsapp-web.js
[website]: https://wwebjs.dev
Expand All @@ -52,4 +61,4 @@ If you experiencing issues with the guide in understaning, please open an issue
[contributing]: https://github.com/wwebjs/wwebjs.dev/tree/candy/.github/CONTRIBUTING.md
[good-first-issue]: https://github.com/wwebjs/wwebjs.dev/contribute
[todo]: https://github.com/wwebjs/wwebjs.dev/projects/1
[discord]: https://discord.gg/H7DqQs4
[discord]: https://discord.gg/H7DqQs4