An open API service indexing awesome lists of open source software.

https://github.com/neeraj1909/twitter-clone


https://github.com/neeraj1909/twitter-clone

django django-framework django-project python twitter-bootstrap twitter-clone

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# Twitter Clone in Django

This is a twitter clone project, developed using Python's web framework Django.

For front-end designing we have used Twitter's front-end library Bootstrap4.

### Getting started with development
Dependenciies:
- Python 3.6.x
- Django 1.11.x
- MySQL 5.7.x
- Ubuntu 17.04 or later

#### 1. Clone this repoistory
```bash
git clone git@github.com:neeraj1909/twitter-clone.git
cd twitter-clone
```

#### 2. Install the [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/)
Follow [instructions on official documentation page](https://virtualenvwrapper.readthedocs.io/en/latest/install.html).

#### 3. Create the virtualenv
```bash
## run following command from `twitter-clone` directory
mkvirtualenv twitter-clone -a "$(pwd)" -p python3.6
```

#### 4. Install python packages
```bash
## Activate the virtualenv which you created on the last step
workon twitter-clone
pip install -r requirements.txt
```

#### 5. Setup the database
*TODO - Add instructions for this when we start using MySQL database.*

#### 6. Run database migrations
```bash
python manage.py migrate
```

#### 7. Run development server
```bash
python manage.py runserver
```

### Contributors
----------
* [Neeraj Singh](https://github.com/neeraj1909)

### License
----------
MIT License

Copyright (c) 2018 Neeraj Kumar Singh

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.