A definitive Star Wars Character Guide featuring all characters from the original and prequel movie trilogies
Explore the docs »
View Demo
·
Report Bug / Request Feature
Table of Contents
Star Wars Guide React, inspired by Star Wars Guide, is the definitive Star Wars Character Guide, featuring all characters from the original and prequel movie trilogies.
This project was originally built as a pratical exercise to learning React, API integration and dialog implementation. Later on, the project was updated to hold fetched API data with Redux and testing with Jest and React Testing Library, delivering more content with better performance and increased confidence.
Star Wars Guide React was built with the following technologies:
To get a local copy up and running follow these simple example steps.
Have npm installed in your machine.
- npm
npm install npm@latest -g
On terminal
- Clone the repo
git clone https://github.com/sgtbrunner/star-wars-guide-react
- Navigate to project folder
cd star-wars-guide-react - Install NPM packages
npm install
Run the following commands on terminal within the project folder
-
Starting the app
npm start
If you browser doesn't open automatically, open it and navigate to
http://localhost:3000/
Once loaded, you can search for your favorite Star Wars characters and check their info:
-
Formatting the app
npm run format
-
Linting the app
npm run lint
-
Testing the app
npm testTo check for testing coverage:
npm run test-coverage
-
Building the app
npm run build
See the open issues for a list of proposed features (and known issues).
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
Guilherme Brunner - guilherme.brunner@gmail.com
Project Link: https://github.com/sgtbrunner/star-wars-guide-react