Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arrudadev/ignite-reactjs-github-explorer

Code produced during module 1 of the Ignite course on the React Js trail of the Rocketseat platform
https://github.com/arrudadev/ignite-reactjs-github-explorer

babel reactjs rocketseat typescript webpack

Last synced: 15 days ago
JSON representation

Code produced during module 1 of the Ignite course on the React Js trail of the Rocketseat platform

Awesome Lists containing this project

README

        


Ignite - GitHub Explorer

[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

> Code produced during module 1 of the Ignite course on the React Js trail of the Rocketseat platform.

In this module, the basic structure of a React application was created using tools such as Webpack, Babel, Webpack Dev server, SASS, Source Maps, Fast Refresh and was taught important React concepts such as components, properties, states and hooks, and adding TypeScript to the project to add static typing to the application.

GitHub Explorer

# :pushpin: Table of Contents

* [Technologies](#-technologies)
* [Installation](#construction_worker-installation)
* [Getting Started](#runner-getting-started)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)

## 💻 Technologies

This project was developed with the following technologies:

- [Typescript](https://www.typescriptlang.org/)
- [React](https://reactjs.org)
- [Webpack](https://webpack.js.org/)
- [Babel](https://babeljs.io/)

# :construction_worker: Installation

**You need to install [Node.js](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/) first, then in order to clone the project via HTTPS, run this command:**

```
git clone https://github.com/monteiro-alexandre/ignite-reactjs-github-explorer.git
```

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:

```
git clone [email protected]:monteiro-alexandre/ignite-reactjs-github-explorer.git
```

**Install dependencies**

```
yarn install
```

Or

```
npm install
```

# :runner: Getting Started

Run the following command to start the application in a development environment:

```yarn dev```

To view the project you can open [localhost:8080](http://localhost:8080).

# :bug: Issues

Feel free to **file a new issue** with a respective title and description on the the [GitHub Explorer](https://github.com/monteiro-alexandre/ignite-reactjs-github-explorer/issues) repository. If you already found a solution to your problem, **I would love to review your pull request**! Have a look at our [contribution guidelines](https://github.com/monteiro-alexandre/ignite-reactjs-github-explorer/blob/master/CONTRIBUTING.md) to find out about the coding standards.

# :tada: Contributing

Check out the [contributing](https://github.com/monteiro-alexandre/ignite-reactjs-github-explorer/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.

# :closed_book: License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.