Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/khoaguin/khoaguin.github.io

Personal Website and Blog
https://github.com/khoaguin/khoaguin.github.io
Last synced: 11 days ago
JSON representation
Personal Website and Blog
Host: GitHub
URL: https://github.com/khoaguin/khoaguin.github.io
Owner: khoaguin
License: mit
Created: 2022-10-21T13:02:46.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2023-12-25T02:39:05.000Z (11 months ago)
Last Synced: 2024-10-07T12:22:10.621Z (about 1 month ago)
Language: SCSS
Homepage:
Size: 63.5 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 10
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project

README

        ### devlopr-jekyll - A Beautiful Jekyll Theme Built for Developers

[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-)

[![Gem Version](https://badge.fury.io/rb/devlopr.svg)](https://badge.fury.io/rb/devlopr)

![workflow-badge](https://github.com/sujaykundu777/devlopr-jekyll/actions/workflows/deploy.yml/badge.svg)

[![Netlify Status](https://api.netlify.com/api/v1/badges/4232ac2b-63e0-4c78-92e0-e95aad5ab8c3/deploy-status)](https://app.netlify.com/sites/devlopr/deploys)

![](https://ruby-gem-downloads-badge.herokuapp.com/devlopr?type=total&color=brightgreen&style=plastic)

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

[![Bakers](https://opencollective.com/devlopr-jekyll/tiers/badge.svg)](https://opencollective.com/devlopr-jekyll/)

You can use Devlopr as a starter for building your own Site. we purposely keep the styling minimal and bare to make it easier to add your own flare and markup. (Under Active Development) !

Highly Customizable and No Hosting or Maintainence Cost is required !

![devlopr jekyll](https://github.com/sujaykundu777/devlopr-jekyll/blob/master/assets/img/screenshot.PNG?raw=true)

devlopr uses Markdown Files to generate data like Blog Posts, Gallery, Shop Products etc. No external database is required.

### Launch your Static Site using Devlopr in minutes :rocket:

To get started follow this [Tutorial](https://devlopr.netlify.app/get-started)

or if you want to try fast :

### Follow this steps in browser (takes 5-10 mins): 

1. Fork this Repo with your name as  your_username.github.io

2. Visit your Fork repo at https://github.com/your_username/your_username.github.io

3. Press "." in keyboard (this will open up vs-code editor in browser) of the repo.

4. Customize config.yml file according to your needs (eg. change your Name, Email... etc.)

5. Commit your changes, and push 

6. Wait for CI/CD to build your website. Visit Github Actions to see the build process.

7. Once Ready, Your website will be ready at https://your_username.github.io :sparkles: 

8. Happy Hacking your new site ! For Local changes you can clone locally.

## Local Development Steps :

### Clone Locally:

```s

$ git clone https://github.com/your_github_username/your_github_username.github.io.git

$ cd your_github_username

```

### For Linux : (Ubuntu 20.04)

To work locally with ubuntu, follow this commands.

Install Ruby :

```s

$ sudo apt install ruby-full

$ ruby --version

ruby 2.7.0p0 (2019-12-25 revision 647ee6f091) [x86_64-linux-gnu]

$ gem install jekyll bundler

$ bundle update

$ bundle install

$ bundle exec jekyll -v

jekyll 4.2.2

$ bundle exec jekyll serve --livereload

```

### For Windows :

To work locally with windows machine, follow this commands. You might need to download and install [ruby (with devkit)](https://www.ruby-lang.org/en/downloads/) and [git](https://git-scm.com/downloads).

```s

$ ruby -v 

(ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [universal.x86_64-darwin21])

$ gem install jekyll bundler

$ bundler -v

Bundler version 2.3.23

$ bundle update

$ bundle install

$ bundle exec jekyll -v 

jekyll 4.2.2

$ bundle exec jekyll serve --livereload

```

If you are running into permission issues running bundler, try the following:

```s

$ sudo rm -rf _site

$ bundle update

$ bundle install

$ bundle exec jekyll serve

```

Start the server locally at http://127.0.0.1:4000/ or http://localhost:4000/

### For MacOS :

Run the following in your terminal :

1. Install Homebrew

`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`

2. Install churby and ruby-install with Homebrew

`brew install chruby ruby-install`

3. Install latest ruby version 

`ruby-install ruby`

4. This will take a few minutes, and once it’s done, configure your shell to automatically use chruby:

```sh

echo "source $(brew --prefix)/opt/chruby/share/chruby/chruby.sh" >> ~/.zshrc

echo "source $(brew --prefix)/opt/chruby/share/chruby/auto.sh" >> ~/.zshrc

echo "chruby ruby-3.1.2" >> ~/.zshrc

```

If you’re using Bash, replace *.zshrc* with *.bash_profile*.

Quit and relaunch Terminal, then check that everything is working:

`$ ruby -v`

ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-darwin21]

5. Install latest gems

```s

$ gem install jekyll bundler

$ bundler -v

Bundler version 2.3.23

$ bundle update

$ bundle exec jekyll -v 

jekyll 4.2.2

$ bundle exec jekyll serve --livereload

```

### Security 

We use codeQL and dependabot alerts for vulnerabality analysis & fixes.

```s

$ bundle audit

```

### Deploy your devlopr-jekyll blog - One Click Deploy

[![Deploy with ZEIT Now](https://zeit.co/button)](https://zeit.co/new/project?template=https://github.com/sujaykundu777/devlopr-jekyll)

[![Deploy with Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/sujaykundu777/devlopr-jekyll)

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/sujaykundu777/devlopr-jekyll)

### Github Actions

This Project has actions to auto deploy jekyll to github pages and firebase. The deployment target can be set by editing the `DEPLOY_STRATEGY` file. Valid values are:

- `none`: default value. use this if you don't want to deploy the site.

- `gh-pages`: deploys to github pages. This uses a custom action available in the Marketplace - [Jekyll Deploy Action](https://github.com/marketplace/actions/deploy-jekyll-site)

- `firebase`: deploys to firebase. Before you can use this you need to first create a firebase project [here](https://console.firebase.google.com/). You can signup for a Free Spark Plan. Then, in your github repo's settings, go to the secrets section and add the following:

  * `FIREBASE_TOKEN`: your firebase token. you can get this by running `firebase login:ci` with the firebase cli.

  * `FIREBASE_PROJECT_ID`: the project id of the project you just created

### Demo (Hosted Apps)

- Github Pages Demo - [here](https://sanketkundu.github.io/)

- Firebase Demo - [here](https://devlopr.web.app)

- Netlify Demo - [here](https://devlopr.netlify.com)

- Vercel Demo - [here](https://devlopr-jekyll.vercel.app/#/)

- Heroku Demo - [here](https://devlopr-jekyll.herokuapp.com)

- AWS Amplify Demo - [here](https://master.d3t30wwddt6jju.amplifyapp.com/)

#### Features :

- Local CMS Admin Support using [Jekyll Admin](https://jekyll.github.io/jekyll-admin/)

- Headless CMS Admin Support using [Netlify CMS](https://sujaykundu.com/blog/how-to-setup-netlify-cms-with-github-pages-hosted-jekyll-blog/)

- Supports Latest [Jekyll 4.x](https://jekyllrb.com) and [Bundler](https://bundler.io)

- Stylesheet built using Sass

- Comments using [Hyvor](https://talk.hyvor.com/) and [Disqus](https://disqus.com/)

- SEO-optimized

- Real Time Search - [Algolia](https://sujaykundu.com/blog/adding-real-time-search-to-jekyll-site-using-algolia/)

- Sell Stuff (Ecommerce) in your Blog using [Snipcart](https://snipcart.com/)

- Send Newsletters using [Mailchimp](https://mailchimp.com/)

- Contact Forms Support for [Getform](https://getform.io), [Formspree](https://formspree.io/)

- Coding Activity using [Wakatime](https://wakatime.com/)

- Hosting Support for [Github Pages](https://pages.github.com), [Netlify](https://netlify.com), [Vercel](https://vercel.com), [Heroku](https://heroku.com), [AWS Amplify](aws.amplify.com), [Firebase](https://firebase.com)

- CI/CD Support using [Travis CI](https://sujaykundu.com/blog/deploy-jekyll-blog-using-github-pages-and-travis-ci/)

#### Jekyll Admin

You can easily manage the site locally using the Jekyll admin : [http://localhost:4000/admin](http://localhost:4000/admin)

![Jekyll Admin](https://github.com/sujaykundu777/devlopr-jekyll/blob/master/assets/img/jekyll-admin.PNG?raw=true)

You can check out for all changelogs [here](https://devlopr.olvy.co/)

## Pull the latest changes

```s

git remote -v

git remote add upstream https://github.com/sujaykundu777/devlopr-jekyll.git

git fetch upstream

git checkout master

git merge upstream/master

git push

```

## Using Docker :

Building the Image :

`docker build -t my-devlopr-jekyll-blog .`

Running the container :

`docker run -d -p 4000:4000 -it --volume="$PWD:/srv/jekyll" --name "my_blog" my-devlopr-jekyll-blog:latest jekyll serve --watch`

## Using Docker Compose :

### Development :

You can run the app in development mode : (your changes will be reflected --watch moded)

Serve the site at http://localhost:4000 :

`docker-compose -f docker-compose-dev.yml up --build --remove-orphans`

### Production :

You can run the app in production mode : (your changes will be reflected --watch moded)

Serve the site at http://localhost:4000 :

`docker-compose -f docker-compose-prod.yml up --build --remove-orphans`

Stop the app :

`docker-compose -f docker-compose-prod.yml down`

Once everything is good and ready to go live -

`docker-compose -f docker-compose-prod.yml up --build --detach`

## Contributors:

This project exists thanks to all the people who contribute.

  

    

      
_{Sujay Kundu}
🚇 🎨 💻

      
_{Ryan Martin}
🚇

      
_{Jack Wu}
🐛

      
_{Iga Kovtun}
🎨 🐛

      
_{Carroll Vance}
🐛

      
_{Andrei Tenescu}
🎨 💻

      
_{Raghwendra Dey}
🐛

    

    

      
_{Daniele Santini}
🐛

      
_Chivaszx
💻

      
_resynth1943
🚇 💻

      
_{Blake Drumm}
💻

      
_{Blake Drumm}
📖

      
_{Filippo Barbari}
💻

      
_{Adam Drumm}
📖

    

  

Contributions are more than just welcome. Fork this repo and create a new branch, then submit a pull request

- 1.Fork it [http://github.com/sujaykundu777/devlopr-jekyll/fork](http://github.com/sujaykundu777/devlopr-jekyll/fork )

- 2.Create your feature branch

`git checkout -b my-new-feature`

- 3.Commit your changes

`git commit -am 'Add some feature'`

- 4.Push to the branch

`git push origin my-new-feature`

- 5.Create new Pull Request

## Support this Project:

Back this project by Donating to our [Open Collective](https://opencollective.com/devlopr-jekyll/donate) or if you like my work[Buymeacoffee](https://buymeacoffee.com/sujaykundu).

Thanks to all our Backers ! [Become a Backer](https://opencollective.com/devlopr-jekyll/donate)





### For Help :

You can contact me, if you need any help via [Email](mailto:[email protected]). If you like the project. Don't forget to :star: !

## Licence

The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). You can do anything you want, including projects for your clients, as long as you mention an attribution back (credit links in footer). See the [Licence](https://github.com/sujaykundu777/devlopr-jekyll/blob/master/LICENSE) file