Share N Learn is a Common Platform for Students & Faculties to upload and share files including all sorts of study material which will be accessible to all the registered members.
Goal
To 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.
In the future, the platform can also serve as an e-library for college students.
Tech Stack
- HTML, CSS and Javascript
- Python Django Framework
Hit
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Development Environment Setup: Windows
Step 1: Downloading and Installing the Code Editor
You can install any one of the following code editors.
Step 2: Installing Python 3.7
Download Python 3.7 or higher
- Download the Windows x86-64 executable installer for the 64-bit version of Windows
- Download the Windows x86 executable installer for the 32-bit version of Windows.
- Make sure to check 'Add Python 3.7 to Path' in the setup window of the Installer.
Verify the installation from the command prompt (Terminal) using the following command,
python --versionInstalled version of python will be printed.
Step 5: Creating Project Directory
Note: We're creating project directory on the desktop for easy and fast access.
cd desktop
mkdir myprojects
cd myprojectsStep 6: Cloning Repository using Git
git clone https://github.com/'<your-github-username>'/sharenlearn.gitStep 7: Change directory to sharenlearn
cd sharenlearnStep 8: Add a reference to the original repository
git remote add upstream https://github.com/chiraag-kakar/sharenlearn.gitStep 9: Creating Virtual Environment
Install virtualenv
pip3 install virtualenvCreating Virtual Environment named myvenv
virtualenv myvenv -p python3.7To Activate myvenv
myvenv\Scripts\activateTo deactivate myvenv
deactivateStep 10: Installing Requirements
Note: Before installing requirements, Make sure Virtual Environment is activated.
pip install -r requirements.txtStep 11: Making database migrations
python manage.py makemigrations
python manage.py migrateStep 12: Creating superuser to access Admin Panel
python manage.py createsuperuserStep 13: Running the Project in local server
Note: Before running the project in local server, Make sure you activate the Virtual Environment.
python manage.py runserver- Always keep your master branch in sync with the main repository byr running the following command on the local master branch. Refer this stackoverflow page.
git pull upstream master- Always create a new branch before making any changes. Never ever make any changes directly on the master branch. To create a new branch,
git checkout -b '<new-branch-name>'Congratulations on setting up the project locally.
Contributing
-
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
-
For major changes, please open an issue first to discuss what you would like to change.
-
Note: Please take a moment to review the Contributing.md and Code of Conduct which provides the guidelines for contributing.
-
Fork the project.
-
Create your Feature Branch
git checkout -b '<your_branch_name>'- Stage your changes
git add .- Commit your changes
git commit -m '<your_commit_message>'- Push changes to remote
git push origin '<your_branch_name>'- Open a Pull Request
Contributors
|
|
License
This project is licensed under the MIT License - see the LICENSE.md file for details.
Chiraag Kakar
