{"id":16131569,"url":"https://github.com/rubenwardy/renewedtab","last_synced_at":"2025-03-16T09:32:50.534Z","repository":{"id":37654155,"uuid":"369853719","full_name":"rubenwardy/renewedtab","owner":"rubenwardy","description":"A mirror for the Renewed Tab repository: https://gitlab.com/rubenwardy/renewedtab/","archived":false,"fork":false,"pushed_at":"2024-06-10T16:27:26.000Z","size":6755,"stargazers_count":39,"open_issues_count":1,"forks_count":11,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-10T22:25:24.381Z","etag":null,"topics":["chrome-extension","firefox-addon","firefox-extension","react","typescript","webextension"],"latest_commit_sha":null,"homepage":"https://renewedtab.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rubenwardy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-22T16:18:09.000Z","updated_at":"2024-10-10T14:04:02.000Z","dependencies_parsed_at":"2023-02-10T18:15:30.112Z","dependency_job_id":"73d37bd9-5c60-4461-9186-fcc189917c07","html_url":"https://github.com/rubenwardy/renewedtab","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubenwardy%2Frenewedtab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubenwardy%2Frenewedtab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubenwardy%2Frenewedtab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubenwardy%2Frenewedtab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubenwardy","download_url":"https://codeload.github.com/rubenwardy/renewedtab/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221661603,"owners_count":16859558,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chrome-extension","firefox-addon","firefox-extension","react","typescript","webextension"],"created_at":"2024-10-09T22:25:42.755Z","updated_at":"2024-10-27T10:18:41.598Z","avatar_url":"https://github.com/rubenwardy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Renewed Tab\n\n[![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/)\n\nA clean web browser \"New Tab\" / \"Home page\" page, created using TypeScript and React.\n\nLicense: GPLv3 or later.\n\n## Usage\n\n### Introduction\n\nRenewed Tab has 3 components:\n\n* A web **app**, found at `src/app`. This is written using React, and\n  uses some browser extension APIs when available.\n* An API/proxy **server**, found at `src/server`.\n  This provides various APIs, and allows requests to be proxied to get\n  around CORS. You can also use the production server if you're not changing\n  any APIs.\n* A **webext**, found at `src/webext`. This contains the manifest.json,\n  and will wrap the web app when compiled.\n\n### Dependencies\n\n* Node 16+ and NPM\n* SASS\n\nMake sure to run `npm install`\n\n### Configure\n\nCopy `config.example.json` to `config.json`.\n\n(Optional) If you want to run a local API/proxy server, then you will need to:\n\n* Change `API_URL` and `PROXY_URL` in `config.json` to localhost:\n\n\n\t```js\n\t{\n\t\t\"API_URL\": \"http://localhost:8000/api/\",\n\t\t\"PROXY_URL\": \"http://localhost:8000/proxy/\",\n\n\t\t/* other settings here */\n\t}\n\t```\n\n* Configure some API keys if you want to use third-party services.\n  These are optional, but will prevent some features from working.\n\t* The settings:\n\t\t* `ACCUWEATHER_API_KEY`: AccuWeather.com\n\t\t* `UNSPLASH_ACCESS_KEY`: [Unsplash](https://unsplash.com/oauth/applications)\n\t\t* `EXCHANGERATE_API_KEY`: for currency exchange rates\n\t* You can set the above server settings in `config.json`, or using\n\t  environment variables (recommended for production).\n\n* You can also change other server settings in `config.json`:\n\t* `PROXY_ALLOWED_HOSTS`: Array of allowed host names.\n\n### Debug\n\nMake sure to run `npm install`.\n\n* Web + server: `npm start`\n* Web only: `npm run start:app`\n* Web extension\n\t* Firefox: `npm run start:firefox`\n\t* Chrome: `npm run start:chrome`\n\t* Edge: `npm run start:edge`\n\n### Production\n\nMake sure to run `npm install`, and to set the `NODE_ENV` environment\nvariable to `production`.\n\n* Web + server: `npm run build`\n* Web only: `npm run build:app`\n* Web extension: `npm run package:webext`\n\nAlso see .gitlab-ci.yml.\n\n### More documentation\n\nSee the [docs](docs) folder.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubenwardy%2Frenewedtab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubenwardy%2Frenewedtab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubenwardy%2Frenewedtab/lists"}