Keep track of what you read online, and see what your friends are reading. See breads-server for back end code.

• Save articles you've read online
• See a summary and simple stats of your reading activity
• Tag and favorite articles
• Follow friends to see what they've read, favorited, and tagged
• Global feed to see what is being read by everyone on Breads
• Search for articles and users

• Save other media content like videos, PDFs, and podcasts
• Browser extension
• RSS Feed
• Pocket-like read later feature
• Newsletter that summarizes trends, your friend's readings, etc.

• Installing
• Running
• Testing
• Deploying
• Technologies

After you have forked the project and downloaded the code, install the necessary dependencies using npm or yarn.

To install the packages through npm, run the command npm install

To install the packages through yarn, run the command yarn add

NOTE: In the rest of the documentation, you will come across npm being used for running commands. To use yarn in place of npm for the commands, simply substitute npm for yarn. Example, npm start as yarn start. For more help, checkout migrating from npm.

NOTE: The backend code should be running in order for the front end to behave correctly. See Breads API.

Make sure the necessary dependencies are installed, add environment variables, and type the command npm start

Axios
REACT_APP_AXIOS_URL - backend url (i.e. - 'http://localhost:8080/api')

Before committing your changes, run the command npm test

Tests are not up to date. (This would be a great way to contribute!)

After confirming the tests have passed - see above

1. Keep your fork in sync with this repository (how to merge conflicts):

# Add a new remote upstream repository
git remote add upstream https://github.com/zero-to-mastery/breads-client.git

# Sync your fork
git fetch upstream
git checkout master
git merge upstream/master

2. Push changes to your repo:

git push origin master

3. In your repo GitHub page, create a pull request to the development branch. This will allow us to see changes in a staging environment before merging to master.

4. If everything runs correctly, your pull request will be merged into master.

• React (Create React App)
• TypeScript
• Jest
• CSS

• CircleCI
• Prettier