Hamro Notes

Get your necessary Univeristy Notes

View Demo · Report Bug · Request Feature

✨ Features

• Login/Signup Functionality
• Upload Specific Notes
• Specific groups with related Notes
• Discussion Forums
• Blog section with commenting features

Tech Stack

Stack	-	-	-	-	-
BackEnd	Python	Django	Postgresql	AWS	REST API

Installation

Method 1

Use setup.sh for automating the installation of the project.Make sure your are on project directory

$ chmod +x setup.sh
$ ./setup.sh

Use test.sh for testing with coverage

$ chmod +x test.sh
$ ./test.sh

Method 2

Step 1: Clone the repo

$ git clone https://github.com/iw-academy-project/iw-acad-hamro-note-be.git
$ cd iw-acad-hamro-note-be

Step 2: Setup Environement and install Dependencies

$ virtualenv venv
$ source bin/activate
$ pip install -r requirements.txt

Step 3: Configure env variables

$ cp .env.example .env

Now, edit .env to contain DEBUG = True SECRET_KEY = <your_key> EMAIL_USE_TLS = True EMAIL_HOST = smtp.gmail.com EMAIL_HOST_USER = <your_gmail> EMAIL_HOST_PASSWORD = <your_gmail_password> EMAIL_PORT = 587

Step 4: Configure

$ python manage.py makemigrations
$ python manage.py migrate
$ python manage.py runserver

Make sure, you know to create superuser for administration. You must enable less secure access on the gmail account

Step 5: Running tests with coverage

$ python manage.py test coverage

License

Licensed under the MIT License.

Acknowledgements and Credits

Aju Tamang

Anjal Bam

Rajesh Pandey

Rajesh Pudasaini

Names are sorted by Alphabet