https://github.com/dantelentsoe/github-search-engine

The App uses GitHub API to allow you to retrieve information from github. It uses React, Styled-Components, and Typescript
https://github.com/dantelentsoe/github-search-engine

Last synced: 1 day ago
JSON representation

The App uses GitHub API to allow you to retrieve information from github. It uses React, Styled-Components, and Typescript

• Host: GitHub
• URL: https://github.com/dantelentsoe/github-search-engine
• Owner: DanteLentsoe
• Created: 2021-11-15T15:16:43.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2021-11-16T09:56:40.000Z (almost 3 years ago)
• Last Synced: 2023-03-03T23:33:41.608Z (over 1 year ago)
• Language: TypeScript
• Homepage: https://dantelentsoe.github.io/github-search-engine/
• Size: 1.16 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# github-search-engine

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

## Deployed App

https://dantelentsoe.github.io/github-search-engine/

### Prerequisites

Before we get started, we're going to need to make sure we have a few things installed and available on our machine.

#### Node >= 12

##### MacOS

```bash

curl "https://nodejs.org/dist/latest/node-${VERSION:-$(wget -qO- https://nodejs.org/dist/latest/ | sed -nE 's|.*>node-(.*)\.pkg.*|\1|p')}.pkg" > "$HOME/Downloads/node-latest.pkg" && sudo installer -store -pkg "$HOME/Downloads/node-latest.pkg" -target "/"

```

##### Other

See the installation guides available @ nodejs.org:

https://nodejs.org/en/download/package-manager/

#### Yarn

```bash

npm i -g yarn

```

### Installing

Below is a series of step by step instructions that tell you how to get a development env running.

Create a local clone of the repository

```bash

git clone https://github.com/DanteLentsoe/github-search-engine.git

```

Enter the cloned repositories' directory

```bash

cd github-search-engine

```

Install the projects dependencies

```bash

yarn

```

````

Start the projects development server

```bash

yarn start

````

The project should now be available at http://localhost:3000

### Development

> This environment is deployed to automatically on every merge to the `develop` and `master` branch.

## Deployment

Deployments are handled by github pipelines, below is an overview of how the deployments work:

1. Dependencies are installed with `yarn`

2. Application is built `yarn build`

## Environment Variables

None are applicable

### Deployment Variables

None are applicable

## Built With

Details of the tech stack that has been used.

- [Node](https://nodejs.org) - Server Run Time

- [TypeScript](https://www.typescriptlang.org/) - JavaScript Complier

## Services

No services in use

## Authors

- **Dante Lentsoe** 

## Meta

| Version | Author                              | Date       |

| ------- | ----------------------------------- | ---------- |

| 0.0.1   | Dante Lentsoe  | 15/11/2021 |