GreenStreak is a project designed to help you maintain your GitHub activity streak every day. Stay consistent and keep your streak alive effortlessly!
- Create Repository: Create New Repository for Logs.
- Daily Updates: The README file is automatically updated to Logs Repository with the current date every day.
- Streak Tracking: Watch your GitHub contributions go green as your streak grows!
- Auto Commit: The process is automated, so you don’t need to worry about manual commits.
Maintaining a streak is a fun and motivational way to stay productive. By committing regularly, you:
- 💡 Stay in the flow of coding
- 🏆 Track your daily progress
- 🌱 Build a habit of consistency
- Docker.
- Github Personal Access Token.
- You simply just click here.
- Genereate new Token (choose the classic one).
- Add Name to your Personal Access Token then check the checkbox called Repo with a description Full control of private repositories
- Generate and Copy your Personal Access Token
Clone Using HTTPS
git clone https://github.com/SpectreMelody/GreenStreak.gitClone Using SSH
git clone git@github.com:SpectreMelody/GreenStreak.gitWith just a few simple steps, you'll be up and running.
Requirement :
- 🐳 Docker
- 🔐 GitHub Personal Access Token
🚀 Step by Step: Automatic Setup :
-
Navigate to the Project Path
Open your terminal and navigate to the directory where the GreenStreak project is located. -
Run the
start.shFile Kickstart the service by running the following command:
sh ./start.sh- Fill in the Requirements
The script will prompt you to provide your GitHub Personal Access Token and any other required details. Once completed, GreenStreak will handle everything for you!
If you prefer more control, GreenStreak also supports manual setup.
Requirement :
- 🐳 Docker (Optional if you want to run Automaticaly)
- 🔐 GitHub Personal Access Token
- 🟢 Node.js
🚀 Step by Step: Manually Setup :
-
Navigate to the Project Path
Open your terminal and navigate to the directory where the GreenStreak project is located. -
Install packages
running the following command:
npm install- Copy the example environment file
running the following command:
cp .env.example .env-
Fill in the .env file
Fill inGITHUB_TOKENwith🔐 GitHub Personal Access TokenandGITHUB_USERNAMEwithYour Github Username. -
Copy the example LAYOUT file
running the following command:
cp LAYOUT.txt.example LAYOUT.txt-
Configure the
LAYOUT.txtFile (OPTIONAL)
Enhance the style of your README logs by customizing theLAYOUT.txtfile! You have the flexibility to change the format to suit your preferences.Important: Be sure to retain the
${date}placeholder in your layout. This dynamic element is essential for automatically inserting the current date into your logs, ensuring that your activity streak is always accurately reflected. -
Run GreenStreak Manually
running the following command:
Production
npm run build && npm run start:prodDevelopment
npm run startRunning GreenStreak in Docker is highly recommended! By using Docker, you don’t have to manually run the project every day—let it take care of your GitHub activity streak automatically, effortlessly!
-
Ensure You’ve Completed the Manual Setup
Before diving into the next steps, double-check that you have successfully set up GreenStreak manually. This will provide a solid foundation for running the project effectively. -
Copy the example docker-compose.yml file
running the following command:
cp docker-compose.yml.example docker-compose.yml- Running Docker By Docker Compose
running the following command:
docker-compose up -dWe appreciate your interest in GreenStreak! Our mission is to help you maintain your GitHub activity streak effortlessly. If you have any questions, suggestions, or feedback, feel free to reach out or contribute to the project.
- ⭐ Star this repository if you find it helpful!
- 🐛 Report issues or suggest features in the issues section.
Happy coding, and keep that streak alive! 🚀