https://github.com/rubenwardy/renewedtab

A mirror for the Renewed Tab repository: https://gitlab.com/rubenwardy/renewedtab/
https://github.com/rubenwardy/renewedtab

chrome-extension firefox-addon firefox-extension react typescript webextension

Last synced: 3 months ago
JSON representation

A mirror for the Renewed Tab repository: https://gitlab.com/rubenwardy/renewedtab/

• Host: GitHub
• URL: https://github.com/rubenwardy/renewedtab
• Owner: rubenwardy
• License: gpl-3.0
• Created: 2021-05-22T16:18:09.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-10T16:27:26.000Z (7 months ago)
• Last Synced: 2024-10-10T22:25:24.381Z (3 months ago)
• Topics: chrome-extension, firefox-addon, firefox-extension, react, typescript, webextension
• Language: TypeScript
• Homepage: https://renewedtab.com/
• Size: 6.44 MB
• Stars: 39
• Watchers: 3
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Renewed Tab

[![pipeline status](https://gitlab.com/renewedtab/renewedtab/badges/master/pipeline.svg)](https://gitlab.com/renewedtab/renewedtab/-/commits/master) [![website](https://img.shields.io/badge/Try_It-Online-blue)](https://web.renewedtab.com/)

A clean web browser "New Tab" / "Home page" page, created using TypeScript and React.

License: GPLv3 or later.

## Usage

### Introduction

Renewed Tab has 3 components:

* A web **app**, found at `src/app`. This is written using React, and

  uses some browser extension APIs when available.

* An API/proxy **server**, found at `src/server`.

  This provides various APIs, and allows requests to be proxied to get

  around CORS. You can also use the production server if you're not changing

  any APIs.

* A **webext**, found at `src/webext`. This contains the manifest.json,

  and will wrap the web app when compiled.

### Dependencies

* Node 16+ and NPM

* SASS

Make sure to run `npm install`

### Configure

Copy `config.example.json` to `config.json`.

(Optional) If you want to run a local API/proxy server, then you will need to:

* Change `API_URL` and `PROXY_URL` in `config.json` to localhost:

	```js

	{

		"API_URL": "http://localhost:8000/api/",

		"PROXY_URL": "http://localhost:8000/proxy/",

		/* other settings here */

	}

	```

* Configure some API keys if you want to use third-party services.

  These are optional, but will prevent some features from working.

	* The settings:

		* `ACCUWEATHER_API_KEY`: AccuWeather.com

		* `UNSPLASH_ACCESS_KEY`: [Unsplash](https://unsplash.com/oauth/applications)

		* `EXCHANGERATE_API_KEY`: for currency exchange rates

	* You can set the above server settings in `config.json`, or using

	  environment variables (recommended for production).

* You can also change other server settings in `config.json`:

	* `PROXY_ALLOWED_HOSTS`: Array of allowed host names.

### Debug

Make sure to run `npm install`.

* Web + server: `npm start`

* Web only: `npm run start:app`

* Web extension

	* Firefox: `npm run start:firefox`

	* Chrome: `npm run start:chrome`

	* Edge: `npm run start:edge`

### Production

Make sure to run `npm install`, and to set the `NODE_ENV` environment

variable to `production`.

* Web + server: `npm run build`

* Web only: `npm run build:app`

* Web extension: `npm run package:webext`

Also see .gitlab-ci.yml.

### More documentation

See the [docs](docs) folder.