Github Trending Frontend App

Repository contains UI application called GitHub Trending Repositories

Application uses BACKEND from Github Unofficial Trending API

!!! IMPORTANT !!!

Github Unofficial Trending API is DOWN. You can run it locally using Docker. Follow README file in Github Unofficial Trending API

Development

To develop this project you should:

• build BACKEND using Docker from Github Unofficial Trending API
• setup PORT for endpoints in .env file (by default it's PORT 8000, but if 8000 will be already allocated set REACT_APP_BASE_URL port accordingly to BACKEND port, otherwise you will not be able to fetch data from endpoints
• run npm install
• and then npm start.

Alternative Setup

• Run this command make run-project
• The application will be alive on port 5005 (localhost:5005)
• If you will run to make: ./setup.sh: Permission denied run chmod 777 setup.sh
• If something goes wrong you can always start this project following Development steps

Technologies

• ReactJS
• Redux
• Redux Toolkit
• TypeScript
• Styled-components (SASS)
• Jest
• React Testing Library

Code owner

Artur Woźniak