Table of Contents
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
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
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!
Push your code to a version control service such as github or gitlab and send a link to the shared repository to [email protected]
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.
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.
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
- Get to https://github.com/jeff-ofobrukweta/starwarz
- Clone the repo
git clone https://github.com/jeff-ofobrukweta/starwarz.git
- Install NPM packages
npm install
- Run unit test
npm run test:unit
- Run lint
npm run lint
- get the dist production build
npm run build
- Get to https://github.com/jeff-ofobrukweta/starwarz
- Clone the repo
git clone https://github.com/jeff-ofobrukweta/starwarz.git
- Install NPM packages
yarn install
- Run unit test
yarn run test:unit
- Run lint
yarn run lint
- get the dist production build
yarn run build
To Get the Flat run command below:
production build
npm run build
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Jefferson . Ofobrukweta . O - @https://www.linkedin.com/in/ofobrukweta-jeff-207506136/ - [email protected]
Project Link: https://github.com/jeff-ofobrukweta/starwarz