Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikesprague/clean-start
Open source new tab Chrome extension
https://github.com/mikesprague/clean-start
browser-extension chrome-extension html-css-javascript javascript nodejs progressive-web-app pwa serverless-functions
Last synced: 3 months ago
JSON representation
Open source new tab Chrome extension
- Host: GitHub
- URL: https://github.com/mikesprague/clean-start
- Owner: mikesprague
- License: mit
- Created: 2020-06-02T16:48:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T14:37:04.000Z (10 months ago)
- Last Synced: 2024-04-12T23:49:10.914Z (10 months ago)
- Topics: browser-extension, chrome-extension, html-css-javascript, javascript, nodejs, progressive-web-app, pwa, serverless-functions
- Language: JavaScript
- Homepage: https://cleanstart.page
- Size: 10.1 MB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Clean Start
Open source new tab extension
[](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=268856900)
## About
- Layout/design based on what I liked from the Momentum browser extension
- Date and time with greeting
- Current temp/conditions (from [OpenWeatherMap](https://openweathermap.org/api))
- uses location data from network the incoming request is made on (location is sometimes unavailable or inaccurate)
- Random quote (quotes provided by [ZenQuotes API](https://zenquotes.io/))
- Random background image (from [Unsplash API](https://unsplash.com/developers/))
- Top posts from some useful sites
- [GitHub Trending Repositories](https://www.github.com/trending/)
- [DEV Community Recent Posts](https://dev.to/)
- [Hacker News Top Posts](https://news.ycombinator.com/)
- [Product Hunt Top Posts](https://producthunt.com/)
- [Reddit Popular Posts](https://www.reddit.com/r/popular)
### Uses
- [React](https://reactjs.org/) - JavaScript Framework
- [Mantine](https://mantine.dev/) - Component Library for React
- [Jotai](https://jotai.org/) - State Management Library for React
- [Vite](https://vitejs.dev/) - Build Tool
- [FontAwesome](https://fontawesome.com/) - Icons
- [Axios](https://github.com/axios/axios/) - HTTP Client
- [dayjs](https://github.com/iamkun/dayjs) - Date Library
- [Roboto Slab via Google Fonts](https://fonts.google.com/specimen/Roboto+Slab?query=roboto+slab) - Font
- [CloudFlare Pages](https://pages.cloudflare.com/) - Hosting and Serverless Functions for API
## Demo
Demo available as a progressive web app (PWA):
- [https://cleanstart.page](https://cleanstart.page)
## Install
- Chrome Store: [https://chrome.google.com/webstore/detail/mmnlbcjgkfloemcbbjhklbblhbcjhmol](https://chrome.google.com/webstore/detail/mmnlbcjgkfloemcbbjhklbblhbcjhmol)
## Build
- Install dependencies `npm install`
- Build extension `npm run build:extension`
- This will create a `build` folder with the extension files and a `clean-start-extension.zip` file (used for submission to Chrome Store)
### Local Development
- Run/develop locally `npm start`
### API Keys
NOTE: You will need API keys from OpenWeatherMap and Unsplash to build and run the serverless functions used as API endpoints for this extension. You can
get API keys for both services for FREE (links below)
OpenWeatherMap
- Developer page
- Sign up for FREE
Unsplash
- Developer page
- Sign up for FREE
Once you have the API keys, make sure to set environment variables for each using the following names:
- `UNSPLASH_ACCESS_KEY`
- `UNSPLASH_SECRET_KEY`
- `OPEN_WEATHERMAP_API_KEY`
For local development, create a file in the root directory of this project named `.dev.vars` with the same format as a typical `.env` file:
```bash
UNSPLASH_ACCESS_KEY="xxxxxx"
UNSPLASH_SECRET_KEY="xxxxxx"
OPEN_WEATHERMAP_API_KEY="xxxxxx"
```
NOTE: for GH Codespaces development, you will need to set the env vars as Actions Secrets in the settings for your forked repo
## License
MIT License
Copyright (c) 2024 Michael Sprague
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.