This Program Is CPU-Intensive Please Make Sure That You're Using A Mid To High Range PC.
ATTENTION : This codebase has been updated in-line with Project-WrapSpeed (Upgrading of Infrasturcture and Services) for users wishing to go back to the Vanilla Js version head to: Commit 0b9d90
- What's New?
- Introduction to ComDash
- Running ComDash On Your Computer
- Running ComDash
- What APIs Should I Subscribe To?
- How Firebase Handles Your Data?
- Other Functions Available
- Issues
- License
Here at Epicalable we are committed in keeping ComDash up-to-date and up-to-speed with the growing tech solutions, services and algorithms. Hence this new commit includes:
ComDash Updates In This Commit:-
Update Highlights:-
1. HUGE UPDATE: Our entire codebase has been re-written with React Js
for the frontend and FireBase as the backend database in-line with Project-WrapSpeed
and React Js will be supported till the forseeable future.
2. A new login page and an improved settings page to store and retrieve Api-keys under
user's email in the Firestore database.
3. To-Do tasks will now be stored in Firestore database under user's email.
4. Logout button has been added on the sidebar for signing out from your email.
Code Checks Manifest:-
All Checks Status: ✅
-----------------------------------------
UX (User Experience) Checks: ✅
BackEnd Code-FrontEnd UI Integration Checks: ✅
(All evaluations are done by the R&D Department)
Last Updated: 14-April-2025 13:48 HRS (Singapore Standard Time)
Publisher: Epicalable
Keep up-to-date with what's happening on this repository by clicking the 'Star' and 'Watch' button on the top right corner of this webpage.
Comdash is an all-in-one web-based Dashboard to get essential day-to-day information such as current weather, weather forecast, global news headlines and store To-do tasks for users. This product is built primarily using React JS as the frontend framework and Firebase as the backend database to store and retrieve user's information.
ComDash can be exectued on you localhost by installing node.js and after initializing npm, Head to pages sub-folder
>>> cd ComDash
Then run the following command in you command line to start your localhost server.
>>> npm run dev
Once the command is executed you will get the following output. You will need to go to the localhost link (here is is http://localhost:5173/) or you can press ctrl + click on the link.
npm run dev
> [email protected] dev
> vite
VITE v6.2.6 ready in 195 ms
➜ Local: http://localhost:5173/
➜ Network: use --host to expose
➜ press h + enter to show help
Now you can enjoy using the web-app.
Upon opening, by default you can track your To-Do tasks so it is best to activate an API. Users should then copy the API key and paste it in the respective input-bars present in the settings page (accessible through the taskbar on the left side).
To do that users will need to head to and register for the following API services :
-
https://openweathermap.org/ : For ComDash to get current weather information and weather forecast for your city and display in WeatherCard.
-
https://gnews.io/ : For ComDash to get current news headlines for your country (chosen in the drop-down list) and display it for you in the NewsCard.
-
https://unsplash.com/developers : For ComDash to get a random background image which is based on your city.
Users should then copy the API key and paste it in the respective input-bars present in the settings page (accessible through the taskbar on the left side).
In ComDash only your Api-keys and your To-Do tasks are saved in the database for easy retrieval. All these information are saved under the E-Mail address which is used for registering in the login page at the start.
Once registered User's Apikeys in the settings page and To-Do list in the Taskcard will be stored in Firestore database as shown below.
For Devs who want to have a private database without storing your info on our databases you can go to Firebase and create a project followed by adding an app.
Then copy the Api keys and other Project keys provided once successful registeration of the app and paste it in the .env file
VITE_API_KEY={your api key}
VITE_AUTH_DOMAIN={your auth domain}
VITE_PROJECT_ID={your project id}
VITE_STORAGE_BUCKET={your storage bucket}
VITE_MESSAGING_SENDER_ID={your sender id}
VITE_APP_ID={your app id}
Enter the following code snippet in your "Rules" section of the Firestore Database.
service cloud.firestore {
match /databases/{database}/documents {
match /users/{userId}/{document=**} {
allow read, write: if request.auth != null && request.auth.uid == userId;
}
}
}
Apart from APIs to retreive information ComDash also comes with some more functionalities for users to use:-
-
Tasks-Tracker:
Comdash allows you to track tasks which will be stored on your browser's local storage (Introduced in commit e42da78 ) to prevent erasing the tasks if you exit or reloaad the page.
-
Calender:
Comdash has an in-built calander which allows you see what date it is.
As this project is still in constant development, if you run into any issues while operating or have any suggestions or features, please feel free to drop by our issues section and open a issue and we'll respond within 2-4 working days, Thank you for your understanding.
IMPORTANT NOTE: Any User who are willing to Share or Re-Distribute ComDash are kindly advised to:
-
A reference to us by keeping a "(C) Epicalable" text in the 'Modified program'.
-
A link to this repository from the user's 'Modified program' README file.
This will be helpful for us as users will know it's original source and about our startup.
Please also refer to LICENSE file for clarifications.
Thank you for your kind co-operation :-)
ComDash Copyright (C) Epicalable 2024
All Rights Reserved
Version 3.1.6