onigiri

onigiri copied to clipboard

onigiri

a very dark, minimal, powerful and fully customizable startpage made using vue.js and tailwind.

🍙 Customize

General Customization

You can customize all the colors and images used in the startpage by changing /config.js accordingingly.

Customizing links

Go to /src/applist.json.

Suppose you want to add FaceBook to the list, just add the following snippet to the json. The Link's position depends on the position of the object in the array.

[
  ...
  {
        "name": "facebook",
        "link": "https://facebook.com",
        "icon": "facebook"
    },
  ...
]

All the ions are taken from Simple Icons. You can check the icon name for your added app here.

🍀 Usage

You can host this startpage on GitHub Pages, Vercel, Netlify or any other platform you may like. Though I would recmmend using vercel if you dont want to waste much time. First of all you will need to create your own fork of this repository and clone it.

Using GitHub Pages

1. Fork the Repo.
2. Clone the fork. Replace your_username with your github username here.

git clone -b pages https://github.com/your_username/onigiri.git

3. Run it to see if everything looks good and then you can customise it.

cd onigiri
npm install
npm run dev

4. Once you have customised it and commited the changes to your fork, run these command in terminal. Replace your_username with your github username here.

npm run build
cd dist
git init
git checkout -b main
git add -A
git commit -m 'deploy'
git push -f https://github.com/your-username/onigiri.git main:gh-pages

5. Head over to your GitHub Repository Settings.
6. Click on the Pages tab.
7. Change publishing branch to gh-pages.
8. Enfore https and hit save. It should look like this:

9. Now you can see your startpage on https://your-username.github.io/onigiri/.
10. Simply change your browser's home page and new tab page to https://your-username.github.io/onigiri/ and you are done.

Using Vercel

1. Fork the Repo.
2. Clone the fork. Replace your_username with your github username here.

git clone -b main https://github.com/your_username/onigiri.git

3. Run it to see if everything looks good and then you can customise it.

cd onigiri
npm install
npm run dev

4. Customise the startpage.
5. Commit the changes.

git add .
git commit -m 'deploy'
git branch -M main
git push -u origin main

6. Create an account on Vercel if you don't already have one.
7. Deploy your startpage by choosing the repository.
8. Change your home page and new tab page to the link given by vercel.

🙋‍♂️ Have Questions?

Create an issue and I'll be glad to help you out!

🎐 Contributing

Contributions are most welcome.

💜 Ending Note

• Consider giving the repo a ⭐ if you liked the project!
• Checkout my other projects!