alejandroid17 / wikistorage

WikiStorage is a simple project with a list of resources that could be useful.

WikiStorage

WikiStorage is a simple project with a list of resources that could be useful.

Usage

The new entries are read from a Telegram channel, using a Telegram Bot and using GitHub Actions and the entries are saved in Firebase.

The entries will be updated depending on the schedule defined in wiki_storage_telegram_bot.yml.

Telegram Bot

In the secret settings of your project on GitHub, you need to define:

• TELEGRAM_CHAT_ID: Telegram channel id.
• TELEGRAM_SECRET_TOKEN: Telegram secret token.

Firebase

In the secret settings of your project on GitHub, you need to define:

• FIREBASE_PROJECT_ID: Firebase project id.
• FIREBASE_AUTH: Firebase settings auth.

Dependencies

• Python 3.8
• NextJS 10.1.3

Deploy

This proyect is deployed using Vercel. Demo

Notes: You need to define a cors proxy. The project uses a custom private fork of CORS Anywhere.

License

MIT

wikistorage's Issues

Configure ESLint in the project

Information

To keep the code clean, configure ESLint

TODO

• Configure ESLint

Use ChakraUI color mode

Information

Right now the dark mode is done using css (invert filter). Chakra UI comes with built-in support for managing color mode.

TODO

• Define dark mode using ChakraUI color mode.

Progress spinner when the cors proxy is starting

Information

When we do not enter the website for a period of time, the proxy cors server must be initialized. This causes the cards to have to wait for data (skeleton).

TODO

• Show spinner until server is up.
• Show messages while is loading.

Responsive interface

Information

When the device's screen is small, the interface is not responsive.

TODO

• Responsive header
  • Hide 'WikiStorage' title
  • Show dark mode and compact mode buttons
• Display content as a list