STARWARS

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. Contact

About The Project

Instructions

As this is a simple consume website for the Star Wars API - there are a few things a user is probably going to want to do.

1.View all root types, and the resources inside them 2.Click though and see a detailed breakdown of the information on each resource type 3.Easily access other linked resources 4.Favorite a resource type - this must persist after page refresh however it doesn't need to be stored on a server

Requirements

1.The UI has to be responsive 2.Loading states while the data is being fetched 3.Test coverage report 4.As important as the feature set is, keeping coding standards and code consistency is key 5.Use react query or redux, whichever you are comfortable with. 6.Add type support by migrating to TypeScript

Design

A good understanding of basic UX principles, and showing that user flow and key actions have been thought through thoroughly This is Star Wars isn't it? Have some fun!

Submission

Push your code to a version control service such as github or gitlab and send a link to the shared repository to [email protected]

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• React
• jestjs

Getting Started

This is an example of how you may give instructions on setting up your project locally. 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.

• npm

  npm install npm@latest -g

Installation using NPM

1. Get to https://github.com/jeff-ofobrukweta/starwarz
2. Clone the repo

   git clone https://github.com/jeff-ofobrukweta/starwarz.git

3. Install NPM packages

   npm install

4. Run unit test

   npm run test:unit

5. Run lint

   npm run lint

6. get the dist production build

   npm run build

Installation using Yarn

1. Get to https://github.com/jeff-ofobrukweta/starwarz
2. Clone the repo

   git clone https://github.com/jeff-ofobrukweta/starwarz.git

3. Install NPM packages

   yarn install

4. Run unit test

   yarn run test:unit

5. Run lint

   yarn run lint

6. get the dist production build

   yarn run build

Usage

To Get the Flat run command below:

Building dist folder for deployment

production build

npm run build

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Jefferson . Ofobrukweta . O - @https://www.linkedin.com/in/ofobrukweta-jeff-207506136/ - [email protected]

Project Link: https://github.com/jeff-ofobrukweta/starwarz