Skip to content

jalalshabo/Twitter-Topic-Tracking

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

79 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Getting started with a fresh clone

After cloning, you need to install a few requirements make sure you have the following installed

  • Node.js : The JavaScript runtime
  • Yarn: A package and project manager for Node.js applications
  • Python: A recent Python 3 interpreter to run Flask backend

Installing missing requirements

Frontend related

  • install missing packages
foo@bar:~/../Twitter-Topic-Tracking$ yarn
foo@bar:~/../Twitter-Topic-Tracking$ yarn install react-spring

Backend related

  • create virtual environment Unix-bas
foo@bar:~/../Twitter-Topic-Tracking$ cd api
foo@bar:~/../Twitter-Topic-Tracking/api$ python3 -m venv venv
foo@bar:~/../Twitter-Topic-Tracking/api$ source venv/bin/activate
(venv) $ _

Windows

foo@bar:~/../Twitter-Topic-Tracking$ cd api
foo@bar:~/../Twitter-Topic-Tracking/api$ python -m venv venv
foo@bar:~/../Twitter-Topic-Tracking/api$ venv\Scripts\activate
(venv) $ _
  • install missing modules
(venv) foo@bar:~/../Twitter-Topic-Tracking/api$ pip install -r requirements.txt

How to run

You will need to open 2 terminal windows

  • start flask backend terminal window
(venv) foo@bar:~/../Twitter-Topic-Tracking/api$ cd ..
windows
(venv) foo@bar:~/../Twitter-Topic-Tracking/$ yarn start-api-windows
linux
(venv) foo@bar:~/../Twitter-Topic-Tracking/$ yarn start-api-linux
  • start react frontend
(venv) foo@bar:~/../Twitter-Topic-Tracking/$ yarn start

The yarn start and yarn start-api commands are described below

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the react frontend in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

proxy is added that points to [http://localhost:5000]
This is for any commands the frontend doesn't understand
They will be forwarded to the backend

yarn start-api

Runs the flask backend in the development mode.
run on [http://localhost:5000]

The page will reload if you make edits.\

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

yarn build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify