Namaste

Introduction 📋

Namaste is an Intelligent Emotion Based Personalised Dashboard that recognizes user's behavior to predict mood and curate various feeds such as Music, News, Calendar, Social Feeds, Movie/Entertainment Feeds, etc. It'll also keep track of User's mood for early detection of Depression and will warn user and try to uplift their mood through various techniques. What's more is that it can be connected to various API Providers such as Facebook, Twitter, Instagram, Amazon, Google, etc to provide user with a single dashboard for everything while also keeping a track of their health through Mood Detection and Google Fit Sensor Data. Besides that a bot will be available for mobile that'll allow user to interact with 'Namaste' This will give user a quick glance and easy access to user's daily internet needs at a single place personalized for them! Future use case involve sharing data with various entertainment providers such as Spotify, Netflix, Youtube, etc for curation of user's feed according to his mood as detected by 'Namaste' Another use case involves tracking of employee's health and behaviour throughout the day by a company to ensure a healthy work environment.

Steps to Setup 📜

You have to fork and clone the project to follow the following setup guidelines:

1. Create Virtual Environment 🌏

$ virtualenv -p python3  VENV_NAME

Activate

windows: > VENV_NAME/Scripts/activate

linux:   $ source VENV_NAME/bin/activate

macos:   $ source VENV_NAME/bin/activate

2. Install requirements ℹ️

$ pip3 install -r requirements.txt

3.

Steps to Contribute 📜

1. Fork it 🍴

You can get a fork/copy of Namaste by using the Fork button.

2. Clone it 👥

You need to clone (download) it to local machine using

$ git clone https://github.com/Your_Username/Namaste.git

This makes a local copy of repository in your machine.

3. Set it up ⬆️

Run the following commands to see that your local copy has a reference to your forked remote repository in Github

$ git remote -v
origin  https://github.com/Your_Username/Namaste.git (fetch)
origin  https://github.com/Your_Username/Namaste.git (push)

Now, lets add a reference to the original Namaste repository using

>$ git remote add upstream https://github.com/omi10859/Namaste.git

This adds a new remote named upstream

See the changes using

$ git remote -v
origin    https://github.com/Your_Username/Namaste.git (fetch)
origin    https://github.com/Your_Username/Namaste.git (push)
upstream  https://github.com/omi10859/Namaste.git (fetch)
upstream  https://github.com/omi10859/Namaste.git (push)

4. Sync it ♻️

Always keep your local copy of repository updated with the original repository. Before making any changes and/or in an appropriate interval, run the following commands carefully to update your local repository.

# Fetch all remote repositories and delete any deleted remote branches
$ git fetch --all --prune

# Switch to `master` branch
$ git checkout master

# Reset local `master` branch to match `upstream` repository's `master` branch
$ git reset --hard upstream/master

# Push changes to your forked `Algo_Ds_Notes` repo
$ git push origin master

5. Ready Steady Go... 🐢 🐇

Once you have completed these steps, you are ready to start contributing by checking our Issues and creating Pull Requests.

6. Create a new branch ‼️

Whenever you are going to make contribution. Please create seperate branch using command and keep your master branch clean (i.e. synced with remote branch).

# It will create a new branch with name Branch_Name and switch to branch Folder_Name
$ git checkout -b Folder_Name

Create a seperate branch for contibution and try to use same name of branch as of folder.

To switch to desired branch

# To switch from one folder to other
$ git checkout Folder_Name

To add the changes to the branch. Use

# To add all files to branch Folder_Name
$ git add .

Type in a message relevant for the code reveiwer using

# This message get associated with all files you have changed
$ git commit -m 'relevant message'

Now, Push your awesome work to your remote repository using

# To push your work to your remote repository
$ git push -u origin Folder_Name

Finally, go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your precious effort.

Code Maintainers 😎

omi10859

thisisayush

dishantsethi