Windowwidth

View Live

Built with:

Languages:

Tools:

Set-up Locally 💻

To get a local copy in your machine, follow these simple steps below.

Prerequisites 📰

You need to confirm that you have this tools before trying to get it to your local computer, confirm these tools, click to install each:

Git

Nodejs

Go to top

### 🛠️ Install locally

1. Copy this project to your github account by forking this repo here, or by clicking the fork icon in the top right corner of this repo.

2. Clone the project to your local code editor, use the following command in your terminal:

   git clone https://github.com/<your-github-username>/windowwidth

3. Navigate to the project directory

   cd windowwidth

4. Install any dependencies with npm install

   npm install

5. Run npm run dev in project root directory using the terminal.

   npm run dev

Go to top

Contribute to the project 💻

Contributing makes this project a great way to collaborate on opensource projects. To contribute, follow these steps below.

1. Set up the project locally using the steps above. Step 1 - 5.

2. Create a new remote for the upstream repository.

This is to update your local copy with any changes made in my own repo here. Do this by using this command:

 git remote add upstream https://github.com/segunajibola/windowwidth 

3. Create a new branch.

  git checkout -b name-of-your-branch          

For example:

git checkout -b my-branch          

This will create a new branch, and switch to it.

4. Make your changes by adding to the code, create a feature or fix a bug. Make the project better.

5. Add your changes to the staging area.

   git add .        

6. Commit your changes.

  git commit -m "Adding an awesome feature to my-branch"      

7. Push your changes to your forked repository.

 git push -u origin my-branch      

8. Create a pull request.

After pushing your changes, go to your forked repo on github to open a pull request. Click on the “Compare and Pull Request” button. If everything went well, I will merge your pull request after neccessary checks.

Go to top

Community 👨‍👩‍👦

Join the WhatsApp community to discuss any issues you have.

License 🧾

Windowwidth is licensed under the MIT License - see the LICENSE file for details.

💪🏽 Thanks to all Contributors

Thank you for reading this and trying to contribute. 🙏

Made with contrib.rocks.

Go to top

🙏🏽 Support

Show your support for this project by:

• Click the star🌟 at the top right corner of this repo.
• Buy me a coffe

Go to top