Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adhamu/startpage
Simple and customisable start page
https://github.com/adhamu/startpage
emotion eslint indexeddb prettier react startpage styled-components typescript webpack
Last synced: 2 months ago
JSON representation
Simple and customisable start page
- Host: GitHub
- URL: https://github.com/adhamu/startpage
- Owner: adhamu
- License: mit
- Created: 2021-01-03T17:02:13.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-26T15:05:43.000Z (over 1 year ago)
- Last Synced: 2024-04-28T06:09:35.952Z (9 months ago)
- Topics: emotion, eslint, indexeddb, prettier, react, startpage, styled-components, typescript, webpack
- Language: TypeScript
- Homepage: https://vigilant-wilson-ef085f.netlify.app
- Size: 1.87 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Startpage
A super simple and customisable landing page.
[](https://github.com/adhamu/startpage/actions)
## Assumptions
Hosted on [Netlify](https://netlify.com)
## Features
- Personalise with your name
- Search with [Google](https://www.google.co.uk), [DuckDuckGo](https://duckduckgo.com) or [Startpage](https://www.startpage.com) including [search suggestions](#search-suggestions)
- Dark Mode
- Customisable theme
- Bookmarks
- Weather
## Technology Stack
- Typescript
- IndexedDB
- React
- Emotion Styled Components
## Serverless Functions
Serverless functions are a part of this project. This means you need to deploy to an environment that supports these such as [Netlify Functions](https://www.netlify.com/products/functions/).
## Tooling
- ESLint
- Prettier
- Parcel
## Installation
### Clone the repository
```sh
$ git clone https://github.com/adhamu/startpage
$ cd startpage
```
## Install Dependencies
```sh
$ yarn
```
## Run it locally
```sh
$ yarn start
```
Open up [http://localhost:8888](http://localhost:8888)
## Building for production
```sh
$ yarn build
```
This will output everything to the `/dist` directory which is where you would point your webserver to. Alternatively, you could host this with Netlify or Github Pages
## Linting
```sh
$ yarn lint
```
## Weather
In order to enable the weather capability, you need to sign up for an API key at [https://openweathermap.org](https://openweathermap.org). Once you have done that, create an `.env` file in the root of the project as follows.
```sh
$ cp .env.example .env
```
```sh
OPEN_WEATHER_API_KEY=YOUR_API_KEY
```