https://github.com/andreynav/star-wars

Wiki app about the Star Wars universe | React, React-query
https://github.com/andreynav/star-wars

react react-icons react-query react-router star-wars star-wars-api styled-components

Last synced: about 1 month ago
JSON representation

Wiki app about the Star Wars universe | React, React-query

• Host: GitHub
• URL: https://github.com/andreynav/star-wars
• Owner: andreynav
• Created: 2023-03-21T16:58:03.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-05-10T18:13:20.000Z (about 3 years ago)
• Last Synced: 2025-02-12T23:39:34.790Z (over 1 year ago)
• Topics: react, react-icons, react-query, react-router, star-wars, star-wars-api, styled-components
• Language: TypeScript
• Homepage:
• Size: 396 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


# General Notes

The project is a web application with information about Star Wars universe. You can select an available characters, species, planets, starships, vehicles and films or search for the specific query. The project is made using React, React Query, React Router,  and Styled components and Typescript.

The project use [REST Star Wars API](https://swapi.dev/).

## Current project status

![GitHub package.json dependency version (prod)](https://img.shields.io/github/last-commit/andreynav/star-wars?label=in%20progress%3A%20last%20commit&style=for-the-badge)

## Dependencies

The project has the next dependencies in the [package.json](package.json) file.



![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/andreynav/star-wars/react?style=for-the-badge)

![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/andreynav/star-wars/react-query?style=for-the-badge)

![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/andreynav/star-wars/axios?style=for-the-badge)

![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/andreynav/star-wars/react-router-dom?style=for-the-badge)

![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/andreynav/star-wars/react-icons?style=for-the-badge)

![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/andreynav/star-wars/styled-components?style=for-the-badge)

![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/andreynav/star-wars/typescript?style=for-the-badge)



## Installation

1. Clone project to your PC by the following command:

```console

  git clone https://github.com/andreynav/countries-wiki.git

```

2. Open the root directory and enter the following command:

```console

  yarn

```

3. In the root directory create `.env` file and add inside it a row `PORT=3003` (or any desired port).

## Running project

To run project, open the root directory and enter the following command:

```console

  yarn start

```

The command runs the app in the development mode.

Open [http://localhost:3002](http://localhost:3003) to view it in your browser.