Thank you for empowering💪🏾🏋🏽♂️ open source by using our project! It's people like you that keep the software community thriving🌱 and relevant. Your contribution means a lot to us💙!
Our documentation site runs on
Assuming you already have Node installed on your machine💻 run the following commands in your working directory📁:
# Creating our working directory
mkdir huetiful && cd huetiful
On this step its a matter of preference💁🏽♂️ to either use git clone for cloning the repository (personally, I prefer npx degit because it is simpler):
# Cloning the repository. It will populate your current working directory with all the files in the repository
npx degit prjctimg/huetiful
Install the necessary dependencies📦 needed to setup the development environment and then run the build👷🏾♂️ script to have the current builds added to a lib/ folder
npm install --save-dev
This project uses Nodemon for testing code as you develop it. You can start a live server that outputs to the terminal. Note that it currently supports JavaScript only. In the root directory, open the file named app.js:
npm start
This will watch the app.js file for any changes when you save it.
This project uses Husky🐶 for Git hooks. For example, the code can only be committed if it passes linting tests which are done using 🧐ESLint. For the code to be pushed to the remote branch it must build without errorsgit push as a pre-push hook.
Our issues are partly managed by GitHub Actions. For example when you open a new issue an automated🤖 response is sent to you telling you how to proceed🚦. You can also self assign yourself an issue or task if you want to work on it👐🏾. This helps other maintainers focus on improving other aspects of the project.
-
Fork the project
-
Clone your fork
-
Create a pr/feature branch
git checkout -b pr/feature
-
Commit your changes
git commit -m 'Added this feature' -
Commit your changes
git push origin pr/feature
-
Open a pull request
Happy hacking 🚀!