https://github.com/tikam02/online-trending
Online Trends & News Aggregator - FullStack WebApp
https://github.com/tikam02/online-trending
aws django git linux online-trends python3 webapp-structure
Last synced: 12 months ago
JSON representation
Online Trends & News Aggregator - FullStack WebApp
- Host: GitHub
- URL: https://github.com/tikam02/online-trending
- Owner: Tikam02
- License: mit
- Created: 2019-02-07T20:46:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-19T21:55:39.000Z (over 6 years ago)
- Last Synced: 2025-06-23T17:56:03.469Z (about 1 year ago)
- Topics: aws, django, git, linux, online-trends, python3, webapp-structure
- Language: Python
- Homepage:
- Size: 17.6 MB
- Stars: 4
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Online-Trending - Apex
  
*****
### [Installation](#project-installation-and-running-locally)
### [Contribution And Development](#developers-guide-to-contribute)
### [Web Application Structure](#webapp-structure)
### [Setting Up Project Environments](#setting-up-virtual-environments)
### [Team Members](#team-members)
### [Git Tutorial](https://www.atlassian.com/git/tutorials/what-is-version-control)
******
******
### Project Installation And Running Locally
First, clone the repository to your local machine:
```
git clone https://github.com/Tikam02/Online-Trending
```
Make sure to add your username and password because this is private Repository and You're collaborator.
Go To the Online-Trending Folder
```bash
cd Online-Trending
```
Activate Virtual Environment
```bash
source env/bin/activate
```
Install the requirements:
```bash
pip3 install -r requirements.txt
```
Apply the migrations:
```bash
python manage.py migrate
```
Apply Make migrations:
```bash
python manage.py makemigration
```
Load the API Services that is stored in services.json,so that it will be loaded to the database.
```
python manage.py loaddata services.json
```
then Crawl the services:
```
python manage.py crawl reddit
```
You can pass multiple services at once:
```
python manage.py crawl reddit hn nytimes
```
Finally, run the development server:
```bash
python manage.py runserver
```
To run the crawler
```
python manage.py crawl reddit
```
The site will be available at **127.0.0.1:8000**.
*****
# WebApp Structure
```
127.0.0.1:8000/login ----->>>> Login Page
127.0.0.1:8000/signup ---->>>> Sign Up Page
127.0.0.1:8000/home ---->>>> Home Page
127.0.0.1:8000/about ---->>>> About Page
127.0.0.1:8000/status ---->>>> Status of Crawler and Server
127.0.0.1:8000/privacy ---->>>>
127.0.0.1:8000/terms ---->>>>
127.0.0.1:8000/logout ---->>>>
```
******
### Developers Guide To Contribute
#### Make Sure That you know proper Git commands before Contributing to thise project, if don't then this tutorial will help.
### [Git Tutorial](https://www.atlassian.com/git/tutorials/what-is-version-control)
#### To create a branch from Terminal
```
$ git fetch && git checkout dev
Make your changes locally and then add, commit, and push your changes to the branch:
$ git add .
$ git commit -m "adding a change from the dev"
$ git push origin dev
```
********
#### Perfect way to git when doing project with your team.
When you have made some changes and and your friend has already pushed it and want you to pull it.
so, if you pull it git will display first commit your changes or merge the files,that will cause merge conflict.
You can overcome this by:
Stash your local changes:
```
git stash
```
Update the branch to the latest code
```
git pull origin dev
```
see your commits from stash
```
git stash show
```
Merge your local changes into the latest code:
```
git stash apply
```
Add, commit and push your changes
```
git add
git commit -m "message"
git push origin dev
```
******
To create a branch locally
You can create a branch locally as long as you have a cloned version of the repo.
```
From your terminal window, list the branches on your repository.
$ git branch
dev
*master
This output indicates there is a single branch, the master and the asterisk indicates it is currently active.
Create a new feature branch in the repository
$ git branch dev
Switch to the feature branch to work on it.
$ git checkout dev
You can list the branches again with the git branch command.
Commit the change to the feature branch:
$ git add .
$ git commit -m "adding a change to the dev branch"
Push the dev branch to Repository
$ git push origin dev
Switch back to the master branch.
$ git checkout master
```
### To Revert The commited Files
```
git revert
git reset
git add
git commit ...
git reset --hard # making sure you didn't have uncommited changes earlier
```
*****
### Setting Up Virtual Environments
### Installing virtualenv
* On Mac and Linux:
```
python3 -m pip install --user virtualenv
```
* On windows:
```
py -m pip install --user virtualenv
```
### Creating Virtual Environment
* On Mac and Linux:
```
python3 -m venv env
```
* On windows:
```
py -m virtualenv env
```
### Activating a virtualenv
* On Mac and Linux:
```
source env/bin/activate
```
* On Windows:
```
.\env\Scripts\activate
```
******
## Team Members
* [Nidhi Gupta](https://github.com/nidhi98gupta)
* [Raksha Rank](https://github.com/RakshaRank)
* [Chirag Podar](https://github.com/ChiragPoddar99)
* [Swapnil Dhimmar](https://github.com/sdhimmar006)
* [Tikam Alma](https://github.com/Tikam02)
* [Amey Ghate](https://github.com/amey-ghate)
* [Shreya Sagar](https://github.com/shreya1706)
* [Vishwa Seth](https://github.com/Vishwa-Sheth)
******