to run the project you should follow the below steps:
-
Install dependencies run
yarn
ornpm install
in your terminal to install the dependencies (be sure that you are in the root directory of the project) -
Define environment variables we have only one environment variable for the github access token which we use for authorization to increase the search rate limit for github API please follow this guide to generate your access token after generating the access token, create a new file in your root directory and name it
.env
and inside it add the following code
REACT_APP_GITHUB_TOKEN = 'your generated access token'
then replace your generated access token with the access token that you have generated from github.
please be sure to restart your development server whenever you make any changes to the environment variables
- Run development server
to run the development server run the following command in your terminal
yarn start
ornpm start
there are some other available commands:
yarn test
ornpm test
to run tests (we don't have tests yet, but we will add it later)yarn build
ornpm build
to build the app for the productionyarn eject
ornpm eject
you can read more about this command here
Requests overview & Cancelling unnecessary requests
- Conventional Commits for commit messages conventions
- BEM for naming conventions
- SASS as a css preprocessor
- Css Grid & Css Flexbox
- React JS
- Typescript
- Redux & React Redux
- redux-thunk
- redux-persist
- axios
- react-icons
- react-infinite-scroll-component
- react-router-dom
- redux-devtools-extension
- Search Users
- Search Repositories
- Search Issues
- Infinite Scrolling
- Cancelling unnecessary requests