Github Portfolio is an app that allows stalkers to check out developers and their repositories.

This app has two modes, in the first mode you can type in a Github username and it shows a few statistics of their profile. In the second mode all repositories are listed of that developer, also with a few statistics.

Before you begin, ensure you have met the following requirements:

• You have installed the latest version of Docker or NodeJS depending on the way you want to run/build the project.

To install Github Portfolio follow these steps:

Any OS:

git clone https://github.com/antonderegt/github-portfolio.git

To use Github Portfolio follow these steps:

Build the image with this command:

docker build -f Dockerfile.dev -t <image_name> .

Once the images has been build you can run the container with the following command:

npm run docker

This spins up a container with the following parameters, which you can see in the package.json.

docker run --rm --name ghp -d -p 8080:8080 -v ${PWD}:/app <image_name>

It runs on port :8080.

Build the image with this command:

docker build -t <image-name> .

Run the container with this command:

docker run --name <container-name> <image-name>

It runs on port :80.

npm install

npm run serve

npm run build

npm run lint

See Configuration Reference.

To run the Jest unit tests run the following command in your terminal

npm run test:unit

To run the Cypress e2e tests install Cypress

npm install -d cypress

and run it like this

npx cypress open

To contribute to Github Portfolio follow these steps:

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name>.
3. Make your changes and commit them: git commit -m '<commit_message>'
4. Push to the original branch: git push origin <project_name>/<location>
5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

Thanks to the following people who have contributed to this project:

• @ghjer 📖
• @tomdeboer 🐛

If you want to contact me you can reach me at [email protected].

This project uses the following license: MIT.