Home
Softono
homepage

homepage

Open source Apache-2.0 TypeScript
42
Stars
10
Forks
1
Issues
4
Watchers
4 years
Last Commit

About homepage

homepage is the source code repository for the organization homepage located at rust-osdev.com. It serves as the central web presence for the Rust OS development community, providing technical documentation, resources, and updates related to operating system development in Rust. The website is built using Zola, a static site generator written in Rust, ensuring fast performance and reliable content delivery. Developers can contribute by cloning the repository and setting up the local development environment. To build and serve the website locally, users must install the Zola tool and execute the "zola serve" command, which starts a development server accessible at localhost:1111. This allows contributors to preview changes in real-time before deployment. The project aims to maintain high-quality educational content and serve as a hub for the Rust OSDev ecosystem. The software is distributed under a dual license, offering users the choice between the Apache License, Version 2.0, and the MIT license. This flexib

Platforms

Web Self-hosted

Languages

TypeScript CSS

Homepage

GitHub release (latest SemVer) GitHub Release Date Build Status GitHub license

Screenshot

Features

  • Search bar.
  • Bookmarks.
  • To Do list.
  • Google Calendar Integration.
  • Weather.
  • Trello Integration.
  • Day and Night wallpaper.

Extra feature: a really mess code that needs a rewrite

How to use

You can run it locally or use the one hosted at GitHub Pages.

Recommended wallpapers

By default homepage has 2 wallpapers, the day wallpaper that is used from 6 am until 6 pm and a night wallpaper that used from 6 pm until 6 am. You can customize and set your own background to it. You can find dynamic wallpapers at https://dynamicwallpaper.club.

Here are some good looking ones:

How to run it locally

First, make sure you have NodeJS and Yarn installed, then clone the repository.

To install all the dependencies, in the repository folder run:

yarn install

After that, start the application with hot reload with:

yarn start

To get a better performance, create a production build with

yarn build

(the folder build/ will be created, just add it to a web server).

Configure Google Calendar Integration

To use the Google Calendar integration locally you need to configure the credentials.

To do so, create a new project and enable the Calendar API in the Google Developers Console and get an API KEY and the CLIENT ID (like this).

With the CLIENT ID and the API KEY, create a file src/config/gapi.json with the following content:

{"apiKey": "YOUR API KEY", "clientId": "YOUR CLIENT ID"}

CHANGELOG

See the CHANGELOG file

License

GPL Logo

This project is licensed under GNU General Public License v2.0.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.