Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sricharankrishnan/jekyll-arabica-boilerplate
A really simple project that serves as a boiler plate for developers building front end websites with Jekyll. Watch video presentation for this boilerplate at https://www.youtube.com/watch?v=TLJuhdXiMXg
https://github.com/sricharankrishnan/jekyll-arabica-boilerplate
boilerplate boilerplate-jekyll gruntjs jekyll jekyll-template
Last synced: 7 days ago
JSON representation
A really simple project that serves as a boiler plate for developers building front end websites with Jekyll. Watch video presentation for this boilerplate at https://www.youtube.com/watch?v=TLJuhdXiMXg
- Host: GitHub
- URL: https://github.com/sricharankrishnan/jekyll-arabica-boilerplate
- Owner: sricharankrishnan
- Created: 2022-02-27T13:20:55.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-23T09:29:51.000Z (6 months ago)
- Last Synced: 2024-12-02T13:14:28.411Z (2 months ago)
- Topics: boilerplate, boilerplate-jekyll, gruntjs, jekyll, jekyll-template
- Language: SCSS
- Homepage:
- Size: 1.42 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jekyll Arabica Boilerplate
### About
A really simple project that serves as a boiler plate for developers building front end websites with Jekyll. Most of the conventions in this boilerplate originate from regular jekyll based terminologies in terms of folder names. However, few simple modifications have been done in order to standardize website building with jekyll in an opiniated but simple manner. Watch the video presentation on [YouTube](https://www.youtube.com/watch?v=TLJuhdXiMXg).
### Built Using
+ [Jekyll - The Static Site Generator](https://jekyllrb.com/)
+ [Shopify Liquid Templating](https://shopify.github.io/liquid/basics/introduction/)
+ Hypertext Markup Language
+ [Sass](https://sass-lang.com/)
+ [Jquery](https://jquery.com/)
+ [Grunt.js - The Javascript Task Runner](https://gruntjs.com/)
+ Integrated with [Snyk.io](https://snyk.io/)
### Getting Started
+ To use this boilerplate, you will need to have some working knowledge of jekyll or any other similar static site generator. For those of you who are first timers with jekyll, I would recommend that you visit their [website](https://jekyllrb.com/).
+ Please ensure that jekyll and gems are installed in your system prior to using this boilerplate. For more infomration, visit the jekyll website on how to install jekyll in your system.
+ To use this boilerplate, execute a git clone command of the repository. You can choose to provide a personalized project folder name:
```console
foo@bar:~$ git clone [email protected]:sricharankrishnan/jekyll-arabica-boilerplate.git [./your-project-folder-name]
```
+ Execute the cleanup command to prepare the scaffold for your development requirements:
```console
foo@bar:~$ cd ./project-folder-name
foo@bar:~$ sh app-cleanup.sh
```
+ Once the cleanup process is complete, execute the below command to start the jekyll server:
```console
foo@bar:~$ npm run start
```
+ Open a browser and proceed to ```http://localhost:4000/``` and you should be able to see the landing page of the boilerplate
+ For more information, please visit the [docs](https://github.com/sricharankrishnan/jekyll-arabica-boilerplate/tree/master/docs) section of the boilerplate
### Supporting This Project
Supporting this project would go a long way in keeping me motivated to build other open source projects. If you like this boilerplate and what it has to offer to the Web Dev community, support this project with a Github Star. Have a nice day ahead and Keep Coding!
You are free to download Espresso without any limitations. I would love to see this project structure being used for your project requirements! If this has made a difference to you, I'm really happy that I've contributed in a positive way.