vitebo / github-explorer Goto Github PK

Save your favorite repositories and track your issues.

Start by accessing the application to explore repositories on github.

• Package manager: Yarn
• Boilerplate: Create React App
• Language: TypeScript
• Styled: Styled Components
• Client http: Axios
• Icon library: React Icons
• Router: React Router
• Linter: Eslint
• Code formatter: Prettier

1 - Clone the project:

$ git clone https://github.com/vitebo/github-explorer.git
$ cd github-explorer
$ yarn install

2 - Install the dependencies:

$ git clone https://github.com/vitebo/github-explorer.git
$ cd github-explorer
$ yarn install

3 - Runs the app in the development mode:

$ yarn start

.
└── src/
    ├── routes/
    ├── styles/
    ├── services/
    ├── assets/
    └── pages/
        ├── Dashboard/
        └── Repository/

• yarn start: Runs the app in the development mode.
• yarn test: Launches the test runner in the interactive watch mode.
• yarn build: Builds the app for production to the build folder.

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

Find on our roadmap the next steps of the project ;)
Want to contribute? Follow these recommendations.

See Releases for detailed changelog.

MIT License © vitebo