Giter Club home page Giter Club logo

startup-page's Introduction

Modular Grid Page

modular grid start page for your browser

Light Mode

preview-light

Dark Mode

preview-dark

Index

About

A side project I created to use everyday. Started with just needing a search bar to quickly search on different sites and unfolded to experimenting with many different modules.

Features

Todo Features

  • Add light/dark mode
  • Replace TDAmeritrade API with other financial API
  • Fix solar chart axis (and other various bugs)
  • Add CMS for bookmarks
  • Make customizable on front end

Tools

Getting started

The weather feature of this page requires you to add an API Key. First create a .env file in the root of the project directory. Then add this variable to the file with the API Key.

# open weather map API
VITE_OPEN_WEATHER_MAP_API_KEY={YOUR_KEY}
VITE_OPEN_WEATHER_MAP_UNIT={imperial_OR_metric}

# TDA API
VITE_TD_CONSUMER_KEY={YOUR_TD_AMERITRADE_API_KEY}

# unsplash API
VITE_ACCESS_KEY={YOUR_UNPLASH_ACCESS_KEY}
VITE_SECRET_KEY={YOUR_UNPLASH_SECRET_KEY}
VITE_UNSPLASH_PHOTO_CATEGORY={PHOTO_CATEGORIES}

# location, leave empty to use the browser Geolocation API
VITE_LAT={YOUR_LATITUDE}
VITE_LON={YOUR_LONGITUDE}

# API key for news api https://newsapi.org
VITE_NEWS_API_KEY={YOUR_NEWS_API_KEY}

# browser preference 
BROWSER={PREF_BROWSER}

Installation

  1. Clone the repo in the directory of your choosing.
    git clone https://github.com/timothypholmes/startup-page.git
  2. Navigate to the root of the directory and run the following command.
    npm install
  3. To compile the site run the following npm command.
    npm run build

Usage

This start page was built with the reactJS framework. To test the page run the command:

npm start

To build the page run the command:

npm run build

and link the static index.html local file to your browser preferences (open on new tab and open on new window)

Or run it using:

serve -s build

Modules

  • solar graph displays suns angular elevation, animated to show sunset and sunrise
  • clock displays time and day
  • weather current weather conditions and temperature using openweather
  • images displays a random sort of pictures using unsplash
  • stockprice displays intraday stock data using tdameritrade
  • bookmarks displays list of bookmarks

API features

  • tdameritrade - stock charts, option chains, account balance
  • openweather - Temperature with weather emoji
  • unsplash - Random photo squares

startup-page's People

Contributors

dependabot[bot] avatar joernkoenen avatar timothypholmes avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.