adhamu / startpage

Simple and customisable start page

Startpage

A super simple and customisable landing page.

Assumptions

Hosted on Netlify

Features

• Personalise with your name
• Search with Google, DuckDuckGo or Startpage including 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.

Tooling

• ESLint
• Prettier
• Parcel

Installation

Clone the repository

$ git clone https://github.com/adhamu/startpage
$ cd startpage

Install Dependencies

$ yarn

Run it locally

$ yarn start

Open up http://localhost:8888

Building for production

$ 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

$ yarn lint

Weather

In order to enable the weather capability, you need to sign up for an API key at https://openweathermap.org. Once you have done that, create an .env file in the root of the project as follows.

$ cp .env.example .env

OPEN_WEATHER_API_KEY=YOUR_API_KEY