Skip to content

Latest commit

 

History

History
193 lines (127 loc) · 3.9 KB

README.md

File metadata and controls

193 lines (127 loc) · 3.9 KB
Raw

Star Wars Viewer

An Star wars view application

About The Project

This is a small Star wars project that consumes SWAPI DEV API to query a variety of star wars characters

Includes features like

  • View all star wars Characters
  • Get Details for a single Star wars character
  • Search Star war character by name

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • Node >= v 12 Project require Node Version 12 and upwards

    Download Node from here

    npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/MuhweziDeo/star-wars.git

  2. Install NPM packages for client

    cd client/
    npm install

  3. Install NPM packages for Server

    cd server/
    npm install

  4. Start Client and Server in different terminals

    Server

    cd server/
    npm run start:dev

    Client

    cd client/
    npm  start

  5. Access the Applications on urls

    Server - http://localhost:5000/graphql

    Frontend - http://localhost:3000

  6. Tests

    client
    cd client/
npm run test

    Server

    cd server/
npm run test

Usage





License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - Muhwezi Deo

Project Link: https://github.com/MuhweziDeo/star-wars