{"id":14967561,"url":"https://github.com/errec/web-learning-kit-generator","last_synced_at":"2025-11-05T12:30:38.738Z","repository":{"id":201829705,"uuid":"72442820","full_name":"Errec/web-learning-kit-generator","owner":"Errec","description":"Web Learning Kit Generator is a tool designed for beginners who want to build static websites with minimal configuration.","archived":false,"fork":false,"pushed_at":"2024-08-20T21:13:07.000Z","size":583,"stargazers_count":99,"open_issues_count":1,"forks_count":31,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-02-11T10:21:19.253Z","etag":null,"topics":["boilerplate","development-environment","gulp","html","jade","javascript","local-development","pug","sass","scss","task-runner","typescript","webkit"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Errec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-10-31T14:11:26.000Z","updated_at":"2024-12-27T10:14:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"72700b55-c596-4c45-b065-6170a59447a4","html_url":"https://github.com/Errec/web-learning-kit-generator","commit_stats":null,"previous_names":["errec/pug-sass-boilerplate-starter-kit","errec/web-boilerplate-starter-kit","errec/web-learning-kit-generator"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Errec%2Fweb-learning-kit-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Errec%2Fweb-learning-kit-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Errec%2Fweb-learning-kit-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Errec%2Fweb-learning-kit-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Errec","download_url":"https://codeload.github.com/Errec/web-learning-kit-generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239458948,"owners_count":19642100,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","development-environment","gulp","html","jade","javascript","local-development","pug","sass","scss","task-runner","typescript","webkit"],"created_at":"2024-09-24T13:38:16.311Z","updated_at":"2025-02-18T11:20:28.418Z","avatar_url":"https://github.com/Errec.png","language":"TypeScript","readme":"# Web Learning Kit Generator\n\n| Web Learning Kit Generator is a tool designed for beginners who want to build static websites with minimal configuration. The application creates a Gulp build process dynamically based on the user's choice of markup language (HTML/Pug), stylesheet language (SASS/SCSS), and scripting language (Javascript/Typescript). It's an easy and fast way to get started with a more realistic development environment on your local machine, beyond online IDEs. | ![Logo](./_gulp/logo.png) |\n|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------:|\n\n\nThis project is based on a simple and fast workflow focused mainly on the front-end task. It gives a solid starting point for newcomers who wants a ready-to-deploy local environment setup. The sources used to build this project includes:\n\n  * [H5BP Project](https://github.com/h5bp/html5-boilerplate)\n  * [React Redux Starter Kit](https://github.com/davezuko/react-redux-starter-kit)\n  * [Mark Goodyear's Blog](https://markgoodyear.com/2014/01/getting-started-with-gulp/)\n  * [Web Starter Kit](https://github.com/google/web-starter-kit)\n\n## Features\n\n  * Dynamic Configuration: Choose your preferred markup (**Pug/HTML**), stylesheet (**Sass/SCSS/CSS**), and script (**JavaScript/TypeScript**) languages, and the tool will generate a customized Gulpfile for you.\n  \n  * Beginner-Friendly: Ideal for those new to web development who want to experiment with real-world tools and workflows.\n  \n  * Extensible: Start simple, and gradually explore more advanced features as you become comfortable.\n  \n  * Minimal Setup: Get up and running quickly without the need for complex configuration.\n  \n  * Realistic Environment: Experience coding outside of online IDEs, and start using Git or other tools as you grow your skills.\n\n  * Bonus: you can add **Josh Comeau** css reset and **Necolas** css normalize\n\n## Prerequisites\n\nBefore you begin, ensure you have the following installed on your system:\n\n* Node.js (v14 or later)\n* **npm** (comes with Node.js) or **Yarn**\n\n## Getting Started\n\n### 1 - Clone or download this repository\n\n### 2 - Install dependencies:\n\nUsing npm:\n```bash\nnpm install\n```\n\nOr using Yarn:\n```bash\nyarn install\n```\n\n## Usage\n\n### Development\n\nTo start the development server with live reloading:\n\n```bash\nyarn start\n```\n\nOr\n```bash\nnpm start\n```\n\nThis will run the `gulp` command, which starts a local server and watches for file changes.\n\n### Production Build\n\nTo create a production-ready build:\n\n```bash\nyarn build\n```\n\nOr\n```bash\nnpm build\n```\n\nThis will generate optimized files in the `dist` directory.\n\n### Running Your Local Server With Gulp\n\nThis task will open the browser window usually with the URL http://localhost:3000/. Any saved changes made to the project files, will reflect automatically over the browser.\n\n## Project Structure\n\n```\n.\n├── src/                # ** Your code folder! **\n│   ├── img/            # Image files\n│   ├── js/             # JS/TS files\n│   ├── styles/         # Sass/SCSS files\n│   └── templates/      # Pug/HTML files\n│   \n├── _gulp/              # Gulp configuration and tasks\n├── dist/               # Production build output\n├── gulpfile.js         # Gulp entry point\n├── package.json        # Project dependencies and scripts\n└── README.md           # Project documentation\n```\nThe src/ directory is created after the Yarn or npm install, **this is where your code journey begins**. The dist/ and build/ folders can be used to host your web project in a simple and convenient way. there are a lot of options to host it, including **Github Pages**\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is open source and available under the [MIT License](LICENSE).\n\n---\n\nFor more detailed information about the gulp tasks and project configuration, please refer to the comments in the `gulpfile.js` and the files in the `_gulp` directory.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferrec%2Fweb-learning-kit-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferrec%2Fweb-learning-kit-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferrec%2Fweb-learning-kit-generator/lists"}