rssviana / foribus-oraculi

Github user search

Foribus-Oraculi

Challenger github user search

This project was created with the purpose of learning new tools and new ways to implement functionalities using React, Typescript, Styled Component, Redux Saga

This project was bootstrapped with Create React App using typescript template.

You can see the application up and running here: Foribus Oraculi

How to run

Install all dependencies using yarn install

Runs the app yarn start

Run all unit tests yarn test

Building project yarn build

How to contribute

• Create an issue with your suggestion
• Create a branch referencing your issue. Example: feat/#number-of-issue or fix/#007
• Open pull request to develop branch
• Wait for CI to pass and review your Pull Request
• In case of success a release branch will be created with the new functionality then a new Pull Request to main and develop will be created

Created with ❤️ @rssviana

foribus-oraculi's Issues

FIX: Routes on netlify

We need to fix routes on netlify serve

Refactor some dispatchs

All dispatch logic needs to be concentrated on the pages and be passed as props for dumb components

Components reference:

• Header
• Hero

Time to sort the list of repositories

We need to use the stars as an ordering parameter

Time to create a Store and github service

We need to create a store fora aplication and a service to create requests to github api

• Redux
• Saga

We need to use the query parameter

We need to use the query parameter on the /user-info/:username route to perform the search directly

When github service return 404, not found page doesn`t shows up

• We need to check request success and then redirect to not-found or user-info page

Time to create tests, tests and more tests

• Great applications are well tested, never forget that

Creating structure of the project

We need use:

• React
• Typescript
• Styled-Component
• Commitlint to standardize commits

And some other extras that may appear halfway .... 😆

Time to create all components, routes and pages

Components

• Header => superior search
• Hero => gigantic middle search
• Repositories = > list os repos
• Sidebar => aside with user data

Pages

• Home with hero component
• User with header, sidebar and repositories components
• Not-found with 404 not found text

Routes

• / || /home => Home page
• /user-info => User page
• /not-found => Home page

Others

• Edit public index
• Adding assets
• Adding fonts
• Adding global style