/100daysof

Repository for 100daysof

Primary LanguageHTMLMIT LicenseMIT

Contributors MIT License


100Daysof

An alternative way to log your progress in any of the 100DaysOfX challenge
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

Product Name Screen Shot

This project is meant to be an alternative way to keep track of your 100DaysOfX. It doesn't matter what you are committed to, but having a clear view of what you have worked on and achieved can be a great motivational activity.

Why should you give this project a try:

  • Can be a great way to see your progress in a structured way
  • Can be used as a start for your own portfolio
  • More structured way to see your log
  • Host yourself on GitHub pages
  • Highly customisable

How did the project come to life.

After participating on #100DaysOfCode I have noticed that it was getting harder to keep track of my logs in a single .md file.

So I came up with an idea to keep track of each day in a separate way and slowly this project started to take shape in my head. Hope you like it and becomes useful to you.

Built With

This project stack is meant to be simple so you can expand and modify it in any way that suits your needs.

Getting Started

This section will help you get started with the site and how to have your own version working on your machine. If you have any trouble with any of these steps make sure to contact me and I'll give you a hand!

Prerequisites

This is a Jekyll site so you will need to have the following things installed on your machine:

  • Ruby (>= 2.2.5)
  • RubyGems
  • GCC and Make

Please read the official Jekyll installation guide if you need help installing any of these requisites on your machine.

Once you have everything installed you can run the following command on your terminal to install Jekyll on your machine.

gem install bundler Jekyll

Also, make sure you have git installed in your machine so you can push your logs to your own repository. If you don't know how, please read the Setting up git guide.

Installation

  1. Open your desired folder for the project
cd documents/
  1. Fork the main repository
  1. Clone your fork of the repository
git clone https://github.com/<your username here>/100daysof.git

Note: A new folder named 100daysof will be created, you don't have to create this yourself.

  1. Add the original repo as your upstream
git remote add upstream https://github.com/FabioRosado/100daysof.git

Note: This step is important for you to update your fork with the latest version.

Usage

You can start this project on your machine by running the following command on your terminal.

bundle exec Jekyll serve

After running that command you should see a message similar to this:

Configuration file: /Users/<user>/Documents/100daysof/_config.yml
            Source: /Users/<user>/Documents/100daysof
       Destination: /Users/<user>/Documents/100daysof/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
       Jekyll Feed: Generating feed for posts
                    done in 0.474 seconds.
 Auto-regeneration: enabled for '/Users/<user>/Documents/100daysof'
    Server address: http://127.0.0.1:4000/
  Server running... press ctrl-c to stop.

Now you can go to http://127.0.0.1:4000/ and you will see a live version of this project.

Contributing

Contributions are what makes the open source community such an amazing place to 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 MIT License. See LICENSE for more information.

Contact

FabioRosado - @FabioRosado_ - FabioRosado@outlook.com

Project Link: https://github.com/fabiorosado/100daysof

Acknowledgements