Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yashchaudhari008/minime
Minimal Homepage
https://github.com/yashchaudhari008/minime
beginner-friendly chrome-extension good-first-issue homepage homepage-app minimalist react vite
Last synced: 3 months ago
JSON representation
Minimal Homepage
- Host: GitHub
- URL: https://github.com/yashchaudhari008/minime
- Owner: yashchaudhari008
- License: mit
- Created: 2023-06-24T16:30:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-07T14:13:18.000Z (4 months ago)
- Last Synced: 2024-07-07T15:33:15.321Z (4 months ago)
- Topics: beginner-friendly, chrome-extension, good-first-issue, homepage, homepage-app, minimalist, react, vite
- Language: TypeScript
- Homepage: https://yashchaudhari008.github.io/minime/
- Size: 93.8 KB
- Stars: 5
- Watchers: 1
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-startpage - Minime - Minimalistic homepage with tabular bookmarks. (Projects / GitHub Pages)
README
# 
Minime
[](https://github.com/yashchaudhari008/minime/actions/workflows/deploy.yml)
Minimal homepage for browsers
## 🖥 Deployed App
App is live on [`github-pages`](https://pages.github.com/) and is available at .
## 🏃 Runnning Locally
Make sure you have [Node.js](http://nodejs.org/)(v20 recommended) installed.
1. Clone the repository & open the project folder
```sh
git clone https://github.com/yashchaudhari008/minime.git
```
2. Install the node packages using `yarn`
```sh
yarn install
```
3. Run development server
```sh
yarn dev
```
Goto [ http://localhost:5173/minime/](http://localhost:5174/minime/) in browser to view the app.
#### Recommended VS Code Extensions
- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
- [Auto Rename Tag](https://marketplace.visualstudio.com/items?itemName=formulahendry.auto-rename-tag)
## 🤝 Contributing
- You can find issues to work on [here](https://github.com/yashchaudhari008/minime/issues)
- Found a bug? or have a good suggestion [create a fresh issue here](https://github.com/yashchaudhari008/minime/issues/new)
#### 🔼 Pull Request Instructions
1. Find/Create an [Issue](https://github.com/yashchaudhari008/minime/issues) to work on.
2. `Fork` the repository.
3. Create a new `feat-[feature-name]` / `bug-[name]` branch from the `main` branch.
4. Make changes and test them.
5. `Commit` your changes.
6. Submit a PR with a meaningful header and link the issue in the PR description.
7. Wait till PR gets reviewed ✔ .
#### ✅ Guidelines
- Make sure you get assigned to issue/bug before you start development.
- Follow naming standards for issues/prs/commits.
- Ask a follow up question if you unsure what to do!
#### ❌ Please Note, Bad Pull Requests Are Not Accepted!
- Changes other than stated issue/bug.
- If your PR contains unnessecary indentation changes, it will be not accepted.
- Do not make duplicate PRs.
## 💁♂️ Contributors
Made with [contributors-img](https://contrib.rocks).
## 📃 License
Distributed under the MIT License. See [LICENSE](LICENSE.md) for more information.
---
THANKS ! Keep Contributing.✌