Profile Updater is a cool project where I try to update the time on my Github profile every minute using API and cloud. Key features:
- Update profile by committing to my profile README.md file using Github Octokit API
- Automate this task by hosting an instance/computer in the cloud (AWS)
To run the ProfileUpdater locally, follow these steps:
-
Clone the repository or download the source code.
git clone https://github.com/lvhoaa/ProfileUpdater.git
-
Navigate to the project directory in your terminal.
-
Install the dependencies by running the following command:
npm install
-
Set up the environment variables. Create a .env file in the root directory and add the necessary configuration variables such as Github personal access Token, Github username, and repository.
-
Run the script using the following command:
node running.js
-
Now the script should be able to make changes to your profile README.md file every minute
-
Host it in the cloud: Launch AWS EC2 Instance and push the script! Use this guide for help.
Contributions to this project are welcome! If you have any suggestions, bug fixes, or new features to propose, please open an issue or submit a pull request.
This project is licensed under the MIT License. You can find the full license text in the LICENSE file.