Twitter Clone

An attempt to build a React.js-Django app cloning Twitter
Explore the docs »

View Deployment · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Twitter Clone is a Django-React web application cloning Twitter web app.

Built With

• Node
• React
• Django REST Framework
• Material UI

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Make sure npm and python are installed.

• npm

  npm --version

• python

  python3 --version

• Postgres.app
  • Only for Mac

Installation

1. Clone the repo and navigate to directory

   git clone https://github.com/zachan-dev/reactjs-django-twitter-clone.git
   cd reactjs-django-twitter-clone

2. Activate python virtual environment

   • Windows:

   python3 -m venv testVenv
   testVenv\Scripts\activate.bat

   • Linux/MacOS:

   python3 -m venv testVenv
   source testVenv/bin/activate

   Export postgres path

   • MacOS:

   export PATH=$PATH:/Applications/Postgres.app/Contents/Versions/latest/bin

3. Install PIP packages

   pip install -r requirements.txt

4. Install NPM packages

   cd frontend
   npm install

5. Build React outputs

   • For Development Environment

   npm run dev

   • For Production Environment

   npm run build

6. Create a top-level .env file

   cd ..
   touch .env

   • With Following Contents:

     SECRET_KEY=<your_secret_key>
     DEBUG=True
     DATABASE_URL=
     

     (Simply leave DATABASE_URL as empty.)

7. Django Init

   python manage.py makemigrations network
   python manage.py makemigrations
   python manage.py migrate
   python manage.py createsuperuser
   

8. Run Django Server

   python manage.py runserver

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @zachan_dev - zach@zachan.dev

Project Link: https://github.com/zachan-dev/reactjs-django-twitter-clone

Acknowledgements