1407arjun/linkhub

A portal to help you find the right resources to boost your learning from all those available on the World Wide Web. Links are ranked based on the feedback by others who have tried it out, so as to provide you only the best of the best.

· Report a bug · Request a feature ·

Table of Contents

1. About The Project
   • Features
   • Tech Stack
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Acknowledgements

About the project

LinkHub is a portal to help learners to find the best resources from those available on the World Wide Web. It builds a network of resources wherein all users can post links of resources which they have used and allowing everybody to rate them. With this, the resources are ranked based on the feedback by others who have tried and tested those, thus to provide the learner only the best of the best.

Features

• No signup required to access the resource data.
• User-friendly and informative UI for desktops.
• Markdown editor to create posts.
• Search using tags, titles or authors.
• Ranking of posts (resources) based on upvotes to downvotes ratio.
• Moderation of posts using flags.

Tech Stack

•  React.js (Next.js)
•  Tailwind CSS
•  Node.js
•  Express.js
•  MongoDB
•  TypeScript

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

In order to get a copy of the project you will require you to have Node.js (v14+) and the NPM package manager installed. If you don't have it, you can download the latest version of Node.js from the official website which also installs the NPM package manager by default.

Installation

Open the terminal in the folder in which you wish to clone the repository and enter the following command:

git clone https://github.com/1407arjun/linkhub.git
cd linkhub

Install all the NPM packages:

npm i

In order to run the project in development mode use:

npm run dev

In order to build the project and run, use:

npm run build
npm start

Note that you will have to add your own .env file at the root directory and add your own environment variables for the project to build. Following are the environment variables used:

• MONGODB_CLIENT_URI - The MongoDB connection string
• AUTH_SECRET - The secret used when creating a session
• NEXTAUTH_URL - The domain name (usually http://localhost:300)
• GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET - The Google OAuth Client ID and Client secret obtained from the Google Cloud Console

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project. (Refer the get started instructions)
2. Create your Feature Branch. (git checkout -b feature/AmazingFeature)
3. Commit your Changes. (git commit -m 'Add some AmazingFeature')
4. Push to the Branch. (git push origin feature/AmazingFeature)
5. Open a Pull Request.

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

1. Freepik - For the background images.
2. Bootstrap Icons - For all the icons used throughout the website.

linkhub's Issues

Utils

• Homepage for non-logged in users
• Universal search bar
• Define tags

Optimizations

• Optimise getServerSideProps() with API calls
• Upgrade to Redux

Search upgrade

• Improve search algorithm
• Add Text summarizer model
• Implement search slugs (:)
• Add autocomplete
• Add search keyboard shortcut

Moderation

• User roles
• Update existing user schema in database
• Delete flags

New landing page

• Landing page redesign
• Add navbar
• Search functionality

Bug: Overwrite in Dev branch

Whenever the frontend or backend is deployed, the dev branch gets overwritten instead of being updated.

Database setup

• User details
• Authentication
• Schema for posts
• Manage upvotes and downvotes

Authentication

• Login/Sign up page
• Google Authentication

Upvotes and Downvotes

On upvotes tab of the profile page, when a post is downvoted, it moves to the downvoted tab when switched but the upvote is still shown as the option on the post in the downvoted tab. It is resolved on refresh. Vice-versa in the downvoted to upvoted tab also.

Authentication 2

• GitHub Authentication
• Facebook Authentication
• Email Authentication (Optional)
• Upgrade auth provider
• Use client side auth

Profile Tabs

Even though the tab is changed through Link or router, the content gets updated but the upvotes and downvotes remain in the same places as the previous tab.

Main Timline

• Timeline/Index page
• Navigation
• Explore panel
• Functionality

Calendar picker icon

Calendar picker icon in the Settings page does not change to white on enabling dark mode

Error Handling

• Setup universal error handlers
• Replace alerts with UI elements
• Improve UI of errors
• Improve/Increase exception handling cases
• Sorting also using flags

Extras

• Pinned topics/posts
• Settings page
• Dark mode

Trending tags

Trending tags become zero after many tags are followed. Returns empty array from the database.

Alerts, Tooltips, etc.

• Configure Flowbite
• Add alerts UI
• Tooltips to nameless buttons

User Profile

• Profile page
• Layout for posts
• New post page (Markdown)