brennanbrown.github.io

brennanbrown.github.io

Just a sort of metasite to show off my GitHub and all of my socials that's scattered across the interwebs!
Explore the docs »

View Site · Report Bug · Request Feature

About The Project

This is a simple website I've created due to the fact I have several projects that are located at https://brennanbrown.github.io, and it felt like a good idea to give those projects a homepage.

Here's a list of projects that are being hosted here via GitHub Pages:

• Stars - https://brennanbrown.github.io/stars: ⭐ A collection of repositories that I've starred, using an automatic service by maguowei.
• Notes - https://brennanbrown.github.io/notes: 📓 My notes on technologies and theory within software and web development.
• Javascript Projects - https://brennanbrown.github.io/javascript-projects/: ☕ Demonstrating my skills and abilities with vanilla JavaScript.
  • Sortable Tables https://brennanbrown.github.io/javascript-projects/sortable-tables: A portfolio piece that addresses some of the common interview questions on arrays, sorting algorithms, and optimizing code performance.
  • Flashcard Game - https://brennanbrown.github.io/javascript-projects/flashcards: Explores some more advanced JavaScript concepts—including how to manage propagation and binding—with interactive card games.
  • Rebound Game - https://brennanbrown.github.io/javascript-projects/rebound-game: Explores game creation with JavaScript as a way of enhancing skills in all areas of development.
• Writings - https://brennanbrown.github.io/old-blog: My first attempt at a personal blog, for collections of essays I've written. Powered by Jekyll.

Installation

Fork the repository

You'll be making your own copy of the "personal website starter" repository so you have your own project to customize. A "fork" is a copy of a repository. So select "Fork" atop the repository.

Once you've found a home for your forked repository, it's yours. You're the owner, so you're ready to publish, if you wish.

Install in your local development environment

If you want to manage your website in a local web development environment, you'll be using Ruby.

Once you've found a home for your forked repository, clone it.

Install Jekyll

Jekyll is a Ruby Gem that can be installed on most systems.

1. Install a full Ruby development environment
2. Install Jekyll and bundler gems

gem install jekyll bundler

3. Change into your new directory

cd personal-website

4. Install missing gems

bundle install

5. Build the site and make it available on a local server

bundle exec jekyll serve

You should see something like:

Configuration file: /octocat/personal-website/_config.yml
            Source: /octocat/personal-website
       Destination: /octocat/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
   GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data.
                    done in 14.729 seconds.
 Auto-regeneration: enabled for '/octocat/personal-website'
    Server address: http://127.0.0.1:4000
  Server running... press ctrl-c to stop.

Don't worry about the "No GitHub API authentication could be found" message. API authentication is only necessary if you intend to display more detailed metadata, like a branch name.

6. Now browse to http://localhost:4000

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPL 3.0 License. You can use this project however you see fit without needing to give attribution, however it cannot be used for for-profit products.

See LICENSE for more information.