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-spacetraveling

Code of the Challenge 5 of the Ignite course on the ReactJs trail of the Rocketseat platform.
https://github.com/arrudadev/ignite-reactjs-spacetraveling

nextjs prismic reactjs rocketseat typescript utterances

Last synced: 18 days ago
JSON representation

Code of the Challenge 5 of the Ignite course on the ReactJs trail of the Rocketseat platform.

Awesome Lists containing this project

README

        


Spacetraveling logo

[![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 of the Challenge 5 of the Ignite course on the ReactJs trail of the Rocketseat platform.

In this challenge, a blog application with Prismic CMS was developed from a Figma layout.

Spacetraveling

# :pushpin: Table of Contents

* [Technologies](#-technologies)
* [Layout](#-layout)
* [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)
- [NextJs](https://nextjs.org/)
- [Prismic](https://prismic.io/)
- [Utteranc](https://utteranc.es/)

## 🔖 Layout

Credits to [Rocketseat](https://github.com/Rocketseat) who created the Layout.

You can view the project layout through [this link](https://www.figma.com/file/yKhO1e6EdWgqwXmbI8oPmg/Desafios-M%C3%B3dulo-3-ReactJS-Copy?node-id=0%3A1). You must have an account at [Figma](http://figma.com/) to access it.

# :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-spacetraveling.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-spacetraveling.git
```

**Install dependencies**

```
yarn install
```

Or

```
npm install
```

# :runner: Getting Started

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

```yarn dev```

# :bug: Issues

Feel free to **file a new issue** with a respective title and description on the the [Spacetraveling](https://github.com/monteiro-alexandre/ignite-reactjs-spacetraveling/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-spacetraveling/blob/master/CONTRIBUTING.md) to find out about the coding standards.

# :tada: Contributing

Check out the [contributing](https://github.com/monteiro-alexandre/ignite-reactjs-spacetraveling/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.