Fork

A good approach to make your own start page is to make a fork of this project. I suggest you to use this method over others. This way, you will have control over your configurations and versions. Please note that new versions might have breaking changes. If you want to update to the latest version, please refer to the updating page for more information.

Fork

1. Fork the project.
2. You may want to remove the .github/workflows folder since it builds Docker image to my Docker repository. (Won't work without my auth information anyway)
3. Install NodeJS and Yarn Package Manager
   • Fire up your beloved terminal
   • Locate to the project directory
   • Use yarn command within project directory to install all dependencies
4. Update the settings.json file and any other files you want to customize. For more information, please refer to How To Customize wiki page.
5. Use yarn dev command to start local server for preview of your changes
6. Commit and push your changes to your remote repository

Please be careful not to send the PR to the original repository if you are using PR's.

Update

Since a fork is a copy of the repository, you can always check the latest changes and make the necessary fixes to your configurations. After doing that, you can pull the latest changes from the repository.

1. Check the releases for breaking changes.
2. Backup your settings.json if you are having trouble with merge conflicts that can occur.
3. Pull the latest changes from upstream (not your origin, which is your fork).
4. Fix your settings.json backup with required changes from release notes, if any.
5. Save it into original settings.json file.

Example Usage Of A Fork

Since you have the source code, you can do anything you want with it! You can change the logic, add more cool stuff which are not present in the current project. You can create your own docker images, serve it either locally or online.

Deploy To A Server

You can deploy your fork to a server easily. I prefer Vercel for such purposes. You can create a Vercel account, and link your own repository there. Whenever you push your changes into main branch, it will automatically deploy your version into Vercel servers, with a human-readable link.

This will host the project just like the preview version of this project, with the changes you made on your fork.

If you prefer this way, please refer to Vercel Documentation for more information and;

• Do not forget to lock your main branch from anyone. Accept pull requests instead.
• Do not push your small changes directly into main branch. I suggest you to use different branches for this.
• Whenever you push your changes on a branch other than main, vercel will provide you a link for preview to test it out. If everything is in order, you can merge it into main to use it as production-ready.

Self Host On Local Machine

You can build the project locally and run it on your device. In order to do that,

• Use yarn build command to build the app.
• Then you can use PM2 or any equivalent service to host the project locally, even auto-start after reboots/restarts.

Docker Images

You can create your own Docker Images if you know how to do so. I have some commands in package.json to kickstart your docker images.

Important

If you want to create images, please update the docker commands in package.json according to your username before running those commands.

Command	Description
yarn docker:build:amd64	Builds an amd64 image
yarn docker:build:arm64	Builds an arm64 image
yarn docker:run	Runs the image on port 8080 while creating a volume for it

You can see the command underneath in package.json file.