Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chiraag-kakar/sharenlearn
A Common File/Resource Sharing Platform for Students & Faculties built using HTML, CSS, Javascript, & Django.
https://github.com/chiraag-kakar/sharenlearn
continuous-deployment css3 django heroku-deployment html5 javascript open-source python pythonanywhere sharenlearn sqlite3
Last synced: 1 day ago
JSON representation
A Common File/Resource Sharing Platform for Students & Faculties built using HTML, CSS, Javascript, & Django.
- Host: GitHub
- URL: https://github.com/chiraag-kakar/sharenlearn
- Owner: chiraag-kakar
- License: mit
- Created: 2020-09-22T19:48:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-08T07:17:08.000Z (almost 3 years ago)
- Last Synced: 2023-08-08T19:43:32.004Z (over 1 year ago)
- Topics: continuous-deployment, css3, django, heroku-deployment, html5, javascript, open-source, python, pythonanywhere, sharenlearn, sqlite3
- Language: HTML
- Homepage: https://sharenlearn.herokuapp.com/
- Size: 36.7 MB
- Stars: 46
- Watchers: 3
- Forks: 77
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: Contributing.md
- License: LICENSE
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
[]()
[]()
[]()
[]()
[](https://github.com/chiraag-kakar/sharenlearn/pulls)
[]()
[]()
[]()
[]()
[](https://sharenlearn.herokuapp.com)
**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 :star2: to show some :heart:
## 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,
```bash
python --version
```
Installed version of python will be printed.
---
Step 3: Installing Git
Download Git
---
Step 4: Fork the Repository
Click on 
to fork this repsository
---
Step 5: Creating Project Directory
Note: We're creating project directory on the desktop for easy and fast access.
```bash
cd desktop
mkdir myprojects
cd myprojects
```
---
Step 6: Cloning Repository using Git
```bash
git clone https://github.com/''/sharenlearn.git
```
---
Step 7: Change directory to sharenlearn
```bash
cd sharenlearn
```
---
Step 8: Add a reference to the original repository
```bash
git remote add upstream https://github.com/chiraag-kakar/sharenlearn.git
```
---
Step 9: Creating Virtual Environment
Install virtualenv
```bash
pip3 install virtualenv
```
Creating Virtual Environment named `myvenv`
```bash
virtualenv myvenv -p python3.7
```
To Activate `myvenv`
```bash
myvenv\Scripts\activate
```
To deactivate `myvenv`
```bash
deactivate
```
---
Step 10: Installing Requirements
Note: Before installing requirements, Make sure Virtual Environment is activated.
```bash
pip install -r requirements.txt
```
---
Step 11: Making database migrations
```bash
python manage.py makemigrations
python manage.py migrate
```
---
Step 12: Creating superuser to access Admin Panel
```bash
python manage.py createsuperuser
```
---
Step 13: Running the Project in local server
Note: Before running the project in local server, Make sure you activate the Virtual Environment.
```bash
python manage.py runserver
```
---
:bulb: Pro Tip!
* 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.
```bash
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,
```bash
git checkout -b ''
```
---
## 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
```bash
git checkout -b ''
```
* Stage your changes
```bash
git add .
```
* Commit your changes
```bash
git commit -m ''
```
* Push changes to remote
```bash
git push origin ''
```
* Open a Pull Request
---
## Contributors
---
## License
This project is licensed under the MIT License - see the LICENSE.md file for details.
---
Chiraag Kakar
