{"id":24299130,"url":"https://github.com/muaaz-raza-dev/resourcle","last_synced_at":"2025-09-26T00:31:29.768Z","repository":{"id":270193473,"uuid":"903844945","full_name":"muaaz-raza-dev/Resourcle","owner":"muaaz-raza-dev","description":"Community driven platform for sharing valuable links","archived":false,"fork":false,"pushed_at":"2025-01-16T12:48:23.000Z","size":6379,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-16T21:18:43.422Z","etag":null,"topics":["express","fastify","nextjs","nodejs","shadcn-ui"],"latest_commit_sha":null,"homepage":"https://resourcle.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/muaaz-raza-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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":"2024-12-15T17:44:41.000Z","updated_at":"2025-01-16T12:48:24.000Z","dependencies_parsed_at":"2024-12-29T08:34:12.773Z","dependency_job_id":"e0045549-b405-4663-a565-5608fe6d7166","html_url":"https://github.com/muaaz-raza-dev/Resourcle","commit_stats":null,"previous_names":["muaaz-raza-dev/unknown","muaaz-raza-dev/resourcle"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muaaz-raza-dev%2FResourcle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muaaz-raza-dev%2FResourcle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muaaz-raza-dev%2FResourcle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muaaz-raza-dev%2FResourcle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/muaaz-raza-dev","download_url":"https://codeload.github.com/muaaz-raza-dev/Resourcle/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234274318,"owners_count":18806538,"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":["express","fastify","nextjs","nodejs","shadcn-ui"],"created_at":"2025-01-16T21:18:47.708Z","updated_at":"2025-09-26T00:31:29.745Z","avatar_url":"https://github.com/muaaz-raza-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Resourcle\nA platform for discovering, sharing, and organizing helpful resources with others\n\n\n***\n\n# Main Features\n- 🔐 User Authentication (Sign In / Sign Up)\n- 🔍 Search and Filter Resources\n- ✍️ Create Public or Private Resources\n- 📚 Organize Links into Collections\n- 📌 Bookmark Favorite Resources\n- 👍 Upvote-Based Ranking System\n- 🔄 Import Browser Bookmarks (Coming Soon)\n\n\n## 🖥️ Tech Stack\n\n- **Frontend:** Next.js 13+ (App Router), Tailwind CSS, TypeScript\n- **Backend:** Express.js, Node.js\n- **Database:** MongoDB (via Mongoose)\n- **Monorepo Tooling:** Turborepo\n- **Others:** Vercel (Frontend), Vercel (Backend)\n\n## 💼 Use Cases\n\n1. **Community Resource Hub**  \n   A platform for users to share and discover resources in a collaborative space.\n\n2. **Personalized Learning Platform**  \n   Curate and organize learning materials for users to bookmark and access.\n\n3. **Content Curation Directory**  \n   Share and organize industry resources, articles, or product recommendations.\n\n4. **Research \u0026 Resource Archive**  \n   A centralized place for professionals to store and share research and articles.\n\n5. **Resource Discovery Platform**  \n   Let users explore and upvote valuable resources across any topic.\n\n---\n\n\n## 🧱 Project Structure (Monorepo)\n\n```bash\nresourcle/ \n├── apps/\n│   ├── frontend       # Next.js application \n│   ├── server         # Express.js backend API \n│   └── util-server    # Utility server (e.g., for secondary tasks like URL verification)\n├── packages/          # Shared code and types \n└── turbo.json         # Turborepo configuration  \n```\n# Installation\n\nFollow these steps to set up the project on your local machine:\n\n## Prerequisites\n\nyou have the following tools installed:\n\n1. Node js (version 16.x or above) [Download here](https://nodejs.org/en)\n2. npm (Node Package Manager) – Comes with Node.js installation.\\\n   Confirm installation by running:\n   ```typescript bash\n   node -v\n   npm -v\n   ```\n3. Git – [Download Here](https://git-scm.com/) .\\\n   Verify by running:\n   ```Text bash\n   git --version\n   ```\n4. MongoDB – A local or cloud database instance for data storage. [Set up MongoDB](https://www.mongodb.com/docs/manual/installation/) .\n\n## Step 1: Clone the Repository\n\nClone the project repository from GitHub to your local machine:\n\n```Text bash\ngit clone https://github.com/muaaz-raza-dev/Resourcle.git\n```\n\nNavigate to the project directory:\n\n```\ncd resourcle\n```\n\n## Step 2: Install Dependencies\n\nThis project uses Turborepo to manage multiple apps within a monorepo. Install all dependencies from the root directory:\n\n```Text bash\nnpm install\n```\n\nThis command will install all the packages listed in the package.json file, including backend and frontend dependencies.\n\n## Step 3: Configure Environment Variables\n\n1. Create a .env file in the root directory\n2. Add the required environment variables as shown in the .env.example file. For example:\n\n```Text bash\ncp apps/frontend/.env.example apps/frontend/.env \ncp apps/server/.env.sample ./apps/server/.env\n```\n\nReplace placeholders like where API keys needed replace with your actual configuration values.\n\n## Step 4: Start the Development Server\n\nRun both server and frontend simultaneously . Move to root folder\n\n```Text bash\nnpm run dev\n```\n\nAlternatively, you can start apps individually:\n\n* Backend (API):\n\n```Text bash\ncd apps/server\nnpm run dev\n```\n\n* Frontend (Web):\n\n```Text bash\ncd apps/frontend\nnpm run dev\n```\n\n* Utility Server (util-server):\n\n```Text bash\ncd apps/util-server\nnpm run dev\n```\n\n## Step 5: Seed database \n\nThe project includes a database seeder script for fresh start, run it after starting the backend:\n\n```Text bash\ncd apps/server\nnpm run seed\n```\n\n\u003cbr /\u003e\n\n## Step 6: Access the Application\n\nOnce the servers are running:\n\n1. Backend: Open [http://localhost:5000](http://localhost:5000) in your browser or use Postman to test API endpoints.\n2. Frontend: Access the application at [http://localhost:3000](http://localhost:3000) in your browser.\n\n\u003cbr /\u003e\n\n## Troubleshooting\n\n* Port Conflicts: Ensure the ports /3000 (web) , /5000 (API) and /4000 (UTIL-SERVER)  are available.\n* Database Issues: Verify that MongoDB is running locally or check your cloud database connection string.\n\n***\n\n# Contributing\n\nContributers are welcome! Please follow the [CONTRIBUTING.md](CONTRIBUTING.md) file for more details.\n\n# License\n\nThis project is licensed under the Apache-2.0 license License. See the [LICENSE](LICENSE) file for details.\n\n## Acknowledgements\n\nResourcle is built with the power of the modern web stack and amazing open-source tools:\n\n- [Next.js](https://nextjs.org/)\n- [Express.js](https://expressjs.com/)\n- [TypeScript](https://www.typescriptlang.org/)\n- [MongoDB](https://www.mongodb.com/)\n- [Cloudinary](https://cloudinary.com/) for media storage\n- [Turborepo](https://turbo.build/repo) for monorepo management\n\n## 💬 Support \u0026 Feedback\n\nFound a bug, have a feature request, or just want to say hi?  \nFeel free to [open an issue](https://github.com/muaaz-raza-dev/resourcle/issues) or reach out via [email](mailto:support@resourcle.com).\n\n---","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuaaz-raza-dev%2Fresourcle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuaaz-raza-dev%2Fresourcle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuaaz-raza-dev%2Fresourcle/lists"}