wanderhungerbuhler / lsrepositories

Coding Test

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


About the challenge

In this personal project, you should be able to write a React App using whatever tools you want.

What you are building

You will be building a simple React app to search for Github users and display their information. You will be using the Github API.

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • ReactJS
  • Styled-components
  • Tests with Vitest
  • HTML5
  • CSS3

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Clone the repo

    git clone https://github.com/wanderhungerbuhler/lsrepositories.git
  2. Install NPM or YARN packages

    npm install
    yarn install

Take the test with Cypress

  1. Run project

    yarn dev
  2. Run Cypress

    yarn cypress:open

Configure Environment

For the project to run 100%, you need to set the Github-specific api in your .env

VITE_APP_API=https://api.github.com

Roadmap

  • Profile Picture
  • Name
  • Total number of repositories
  • List of repositories with pagination (repository name and description)
  • Tests

Contact

Wander HungerbĂĽhler - whfdev@gmail.com

Project Link: LS Repositories

About

Coding Test


Languages

Language:TypeScript 96.7%Language:HTML 3.2%Language:Shell 0.1%