{"id":25185994,"url":"https://github.com/chiraag-kakar/sharenlearn","last_synced_at":"2025-06-25T13:04:11.314Z","repository":{"id":43324053,"uuid":"297755788","full_name":"chiraag-kakar/sharenlearn","owner":"chiraag-kakar","description":"A Common File/Resource Sharing Platform for Students \u0026 Faculties built using HTML, CSS, Javascript, \u0026 Django.","archived":false,"fork":false,"pushed_at":"2022-03-08T07:17:08.000Z","size":38454,"stargazers_count":45,"open_issues_count":6,"forks_count":78,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-25T13:03:59.288Z","etag":null,"topics":["continuous-deployment","css3","django","heroku-deployment","html5","javascript","open-source","python","pythonanywhere","sharenlearn","sqlite3"],"latest_commit_sha":null,"homepage":"https://sharenlearn.herokuapp.com/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chiraag-kakar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"Contributing.md","funding":null,"license":"LICENSE","code_of_conduct":"code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-22T19:48:13.000Z","updated_at":"2024-10-09T07:33:39.000Z","dependencies_parsed_at":"2022-09-03T04:52:59.768Z","dependency_job_id":null,"html_url":"https://github.com/chiraag-kakar/sharenlearn","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/chiraag-kakar/sharenlearn","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chiraag-kakar%2Fsharenlearn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chiraag-kakar%2Fsharenlearn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chiraag-kakar%2Fsharenlearn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chiraag-kakar%2Fsharenlearn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chiraag-kakar","download_url":"https://codeload.github.com/chiraag-kakar/sharenlearn/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chiraag-kakar%2Fsharenlearn/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261879271,"owners_count":23223736,"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":["continuous-deployment","css3","django","heroku-deployment","html5","javascript","open-source","python","pythonanywhere","sharenlearn","sqlite3"],"created_at":"2025-02-09T19:41:16.290Z","updated_at":"2025-06-25T13:04:11.272Z","avatar_url":"https://github.com/chiraag-kakar.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Banner --\u003e\n\n\u003ccenter\u003e\u003ca href=\"https://github.com/chiraag-kakar/sharenlearn/\" title=\"ShareNLearn\"\u003e\u003cimg src=\"./banner.svg\" width=\"800\" height=\"700\"\u003e\u003c/a\u003e\u003c/center\u003e\n\u003c!-- style=\"max-width=100%;\" --\u003e\n\u003c!-- Status --\u003e\n\n[![](https://img.shields.io/github/license/chiraag-kakar/sharenlearn?style=for-the-badge)]()\n[![](https://img.shields.io/tokei/lines/github/chiraag-kakar/sharenlearn?label=Lines%20of%20Code\u0026style=for-the-badge)]()\n[![](https://img.shields.io/github/issues-raw/chiraag-kakar/sharenlearn?color=orange\u0026style=for-the-badge)]()\n[![](https://img.shields.io/github/issues-closed/chiraag-kakar/sharenlearn?style=for-the-badge)]()\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge)](https://github.com/chiraag-kakar/sharenlearn/pulls)\n[![](https://img.shields.io/github/issues-pr-closed-raw/chiraag-kakar/sharenlearn?style=for-the-badge)]()\n[![](https://img.shields.io/github/issues-pr/chiraag-kakar/sharenlearn?style=for-the-badge)]()\n[![](https://img.shields.io/github/forks/chiraag-kakar/sharenlearn?style=for-the-badge)]()\n[![](https://img.shields.io/github/stars/chiraag-kakar/sharenlearn?style=for-the-badge)]()\n[![](https://img.shields.io/website?style=for-the-badge\u0026url=https://sharenlearn.herokuapp.com)](https://sharenlearn.herokuapp.com)\n\n**Share N Learn** is a Common Platform for Students \u0026 Faculties to upload and share files including all sorts of study material which will be accessible to all the registered members.\n\n### Goal\n\nTo create a secure and scalable platform common to both college students and faculties so that they can easily share the resources related to coursework hence reducing the dependency on social media platforms.\n\nIn the future, the platform can also serve as an e-library for college students.\n\n### Tech Stack\n\n- HTML, CSS and Javascript\n- Python \u003ca href=\"https://docs.djangoproject.com/en/3.1/\"\u003eDjango\u003c/a\u003e Framework\n\nHit \u003ca href=\"#\" title=\"Star ShareNLearn\" target=\"_self\"\u003e:star2:\u003c/a\u003e to show some :heart:\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Development Environment Setup: Windows\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 1: Downloading and Installing the Code Editor\n\u003c/summary\u003e\n\u003cbr\u003e\nYou can install any one of the following code editors.\n\u003cbr\u003e\u003cbr\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href=\"https://code.visualstudio.com/\"\u003eVisual Studio Code\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"https://www.sublimetext.com/3\"\u003eSublime Text 3\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"https://atom.io/\"\u003eAtom\u003c/a\u003e\u003c/li\u003e\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 2: Installing Python 3.7\n\u003c/summary\u003e\n\u003cbr\u003e\nDownload \u003ca href=\"https://www.python.org/downloads/\"\u003ePython 3.7 or higher\u003c/a\u003e\n\u003cbr\u003e\u003cbr\u003e\n\u003cul\u003e\n\u003cli\u003eDownload the Windows x86-64 executable installer for the 64-bit version of Windows\u003c/li\u003e\n\u003cli\u003eDownload the Windows x86 executable installer for the 32-bit version of Windows.\u003c/li\u003e\n\u003cli\u003eMake sure to check '\u003cb\u003eAdd Python 3.7 to Path\u003c/b\u003e' in the setup window of the Installer.\u003c/li\u003e\n\u003c/ul\u003e\n\nVerify the installation from the command prompt (Terminal) using the following command,\n\n```bash\npython --version\n```\n\nInstalled version of python will be printed.\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 3: Installing Git\n\u003c/summary\u003e\n\u003cbr\u003e\nDownload \u003ca href=\"https://git-scm.com/downloads\"\u003eGit\u003c/a\u003e\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 4: Fork the Repository\n\u003c/summary\u003e\n\u003cbr\u003e\nClick on \u003ca href=\"#\" target=\"_self\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/63921263/110382285-b07bba80-8080-11eb-8407-d354849c1753.png\" width=\"16\"\u003e\u003c/img\u003e\u003c/a\u003e to fork \u003ca href=\"https://github.com/chiraag-kakar/sharenlearn\"\u003ethis\u003c/a\u003e repsository\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 5: Creating Project Directory\n\u003c/summary\u003e\n\u003cbr\u003e\nNote: We're creating project directory on the desktop for easy and fast access.\n\u003cbr\u003e\u003cbr\u003e\n\n```bash\ncd desktop\n\nmkdir myprojects\n\ncd myprojects\n```\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 6: Cloning Repository using Git\n\u003c/summary\u003e\n\u003cbr\u003e\n\n```bash\ngit clone https://github.com/'\u003cyour-github-username\u003e'/sharenlearn.git\n```\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 7: Change directory to sharenlearn\n\u003c/summary\u003e\n\u003cbr\u003e\n\n```bash\ncd sharenlearn\n```\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 8: Add a reference to the original repository\n\u003c/summary\u003e\n\u003cbr\u003e\n\n```bash\ngit remote add upstream https://github.com/chiraag-kakar/sharenlearn.git\n```\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 9: Creating Virtual Environment\n\u003c/summary\u003e\n\u003cbr\u003e\nInstall virtualenv\n\u003cbr\u003e\u003cbr\u003e\n\n```bash\npip3 install virtualenv\n```\n\nCreating Virtual Environment named `myvenv`\n\n```bash\nvirtualenv myvenv -p python3.7\n```\n\nTo Activate `myvenv`\n\n```bash\nmyvenv\\Scripts\\activate\n```\n\nTo deactivate `myvenv`\n\n```bash\ndeactivate\n```\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 10: Installing Requirements\n\u003c/summary\u003e\n\u003cbr\u003e\nNote: Before installing requirements, Make sure Virtual Environment is activated.\n\u003cbr\u003e\u003cbr\u003e\n\n```bash\npip install -r requirements.txt\n```\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 11: Making database migrations\n\u003c/summary\u003e\n\u003cbr\u003e\n\n```bash\npython manage.py makemigrations\npython manage.py migrate\n```\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 12: Creating superuser to access Admin Panel\n\u003c/summary\u003e\n\u003cbr\u003e\n\n```bash\npython manage.py createsuperuser\n```\n\u003c/details\u003e\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\nStep 13: Running the Project in local server\n\u003c/summary\u003e\n\u003cbr\u003e\n\u003cb\u003eNote:\u003c/b\u003e Before running the project in local server, Make sure you activate the Virtual Environment.\n\u003cbr\u003e\u003cbr\u003e\n\n```bash\npython manage.py runserver\n```\n\u003c/details\u003e\n\n---\n\n:bulb: Pro Tip!\n\n* Always keep your master branch in sync with the main repository byr running the following command on the local master branch. Refer \u003ca href=\"https://stackoverflow.com/questions/7244321/how-do-i-update-or-sync-a-forked-repository-on-github#:~:text=git%20remote%20add%20upstream%20https://github.com/whoever/whatever.git\"\u003ethis stackoverflow page.\u003c/a\u003e\n\n```bash\ngit pull upstream master\n```\n\n* Always create a new branch before making any changes. Never ever make any changes directly on the master branch. To create a **new** branch,\n\n```bash\ngit checkout -b '\u003cnew-branch-name\u003e'\n```\n\n---\n\n## Congratulations on setting up the project locally.\n\n---\n\n## Contributing\n\n* Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n* For major changes, please open an \u003ca href=\"https://github.com/chiraag-kakar/sharenlearn/issues\"\u003eissue\u003c/a\u003e first to discuss what you would like to change.\n\n* **Note:** Please take a moment to review the \u003ca href=\"https://github.com/chiraag-kakar/sharenlearn/blob/master/Contributing.md\"\u003eContributing.md\u003c/a\u003e and \u003ca href=\"https://github.com/chiraag-kakar/sharenlearn/blob/master/code_of_conduct.md\"\u003eCode of Conduct\u003c/a\u003e which provides the guidelines for contributing.\n\n* \u003ca href=\"#\" target=\"_self\"\u003eFork\u003c/a\u003e the project.\n* Create your Feature Branch\n```bash\ngit checkout -b '\u003cyour_branch_name\u003e'\n```\n* Stage your changes\n```bash\ngit add .\n```\n* Commit your changes\n```bash\ngit commit -m '\u003cyour_commit_message\u003e'\n```\n* Push changes to remote\n```bash\ngit push origin '\u003cyour_branch_name\u003e'\n```\n* Open a \u003ca href=\"https://github.com/chiraag-kakar/sharenlearn/pulls\"\u003ePull Request\u003c/a\u003e\n\n---\n\n## Contributors\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n\t  \u003ca href=\"https://github.com/chiraag-kakar/sharenlearn/graphs/contributors\"\u003e\n        \u003cimg src=\"https://contrib.rocks/image?repo=chiraag-kakar/sharenlearn\" /\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n---\n\n## License\n\nThis project is licensed under the MIT License - see the \u003ca href=\"https://github.com/chiraag-kakar/sharenlearn/blob/master/LICENSE\"\u003eLICENSE.md\u003c/a\u003e file for details.\n\n---\n\n\u003cp align=\"center\"\u003eChiraag Kakar\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/chiraag-kakar/\"\u003e\n\u003cimg src=\"https://user-images.githubusercontent.com/58631762/120077716-60cded80-c0c9-11eb-983d-80dfa5862d8a.png\" width=\"19\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchiraag-kakar%2Fsharenlearn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchiraag-kakar%2Fsharenlearn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchiraag-kakar%2Fsharenlearn/lists"}