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 built using Django Framework.
The Goal of the project is to create a secure and scalable platform common to both college students and faculties so that they can easily share the files / resources related to coursework , Competitive exams and others hence reducing the dependency on social media platforms. In future the platform can also serve as an e-library for the college students.
So let's grow together.
😃Hit that ⭐ button to show some ❤️
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Any Code Editor (VS Code preferred)
Python version 3.7 or higher
Latest version of Git
A PythonAnywhere Account (for deploying the project on a live system)
Step 1 : Downloading and Installing the Code Editor
| Code Editor | Link |
|---|---|
| Visual Studio Code | Download it from here |
| Sublime Text 3 | Download it from here |
| Atom | Download it from here |
Step 2 : Installing Python
-
Click on Download Python.
-
Click on the "Latest Python 3 Release - Python x.x.x" link.
-
- Download the Windows x86-64 executable installer for 64-bit version of Windows
-
- Download the Windows x86 executable installer for 32-bit version of Windows.
-
-
Make sure to check "Add Python 3.x to Path" in the setup window of the Installer.
Verify the installation from the command prompt using following command :
python --version
And the installed version of python will be printed.
Step 3 : Creating Project Directory
(Note : We are creating project directory in the desktop for easey and fast access)
cd desktop
mkdir myproject
cd myproject
Step 4 : Fork the Repository Cloning Repository using Git
git clone https://github.com/chiraag-kakar/sharenlearn.git
Note: The cloned repo directory need to be renamed as "sharenlearn".
Step 5 : Creating Virtual Environment
Change the directory to the required one where the virtual environment will be created :
cd sharenlearn
Creating Virtual Environment named "myvenv" :
python -m venv myvenv
Activating "myvenv" :
myvenv\Scripts\activate
Command to deactivate "myvenv" :
deactivate
Step 6 : Installing Requirements
Note: Virtual Environment should be activated.
Upgrading pip to the latest version :
python -m pip install --upgrade pip
Installing requirements :
pip install -r requirements.txt
Step 7 : Creating Superuser and making database migrations to access the default Admin Panel
python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser
Step 8 : Running the Project in local server
Note: Virtual Environment should be activated.
Run the following command in the terminal :
python manage.py runserver
- 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.
- 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 to the Branch (
git push origin <your_branch_name>) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE.md file for details.