Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/javitocor/trekkie-world-catalog

A catalog where users will find everything related to Star Trek TV shows, built with React&Redux.
https://github.com/javitocor/trekkie-world-catalog

bootstrap4 css-modules eslint javascript jest npm react-components react-redux react-router reactjs redux redux-thunk startrek stylelint testing-library-react

Last synced: 11 days ago
JSON representation

A catalog where users will find everything related to Star Trek TV shows, built with React&Redux.

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
![Hireable](https://cdn.rawgit.com/hiendv/hireable/master/styles/default/yes.svg)

# Trekkie World Catalog

> A catalog where users will find everything related to Star Trek TV shows, built with React&Redux.

You can find the description of the project [here](https://www.notion.so/Catalogue-of-Statistics-72446e7fa33c403a9b6a0bc1de5c6cf5) ("Catalogue of Statistics")

Landing Page:
![screenshot](./src/assets/screenshot.png)

Episodes Page:
![screenshot](./src/assets/screenshot1.png)

Additional description about the project and its features.

## Built With

- HTML
- CSS
- JAVASCRIPT
- NPM
- REACT
- REDUX
- NODE
- HEROKU
- ESLINT
- STYLELINT
- GITHUB ACTIONS
- VSCODE

## Live Demo

[Heroku Live Demo Link](https://trekkieworld.herokuapp.com/) :point_left:

[Presentation Video Link](https://www.loom.com/share/a862f325acdd4e3c88b6d0e8f24461b1) :point_left:

## Getting Started
- Follow the live demo link and enjoy the site.

### Usage
To have this app on your pc, you need to:
* [download](https://github.com/javitocor/Trekkie-World-Catalog/archive/development.zip) or clone this repo:
- Clone with SSH:
```
[email protected]:javitocor/Trekkie-World-Catalog.git
```
- Clone with HTTPS
```
https://github.com/javitocor/Trekkie-World-Catalog.git
```

* In the project directory, you can run:

- `$ npm install` - installs all the dependencies required by the project

- `$ npm start` - runs the app in the development mode:
- Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
- The page will reload if you make edits.
- You will also see any lint errors in the console.

- `$ npm run test`
- Launches the test runner in the interactive watch mode.
- See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

- `$ npm run build`
- Builds the app for production to the `build` folder.
- It correctly bundles React in production mode and optimizes the build for the best performance.
- The build is minified and the filenames include the hashes.
- Your app is ready to be deployed!

### Automated Test
- `$ npm run test`
- Launches the test runner in the interactive watch mode.

- See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

## Future Features
- Add characters and cast information.

## Author

👤 Javier Oriol Correas Sanchez Cuesta
- Github: [@javitocor](https://github.com/javitocor)
- Twitter: [@JavierCorreas4](https://twitter.com/JavierCorreas4)
- Linkedin: [Javier Oriol Correas Sanchez Cuesta](https://www.linkedin.com/in/javier-correas-sanchez-cuesta-15289482/)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the [issues page](https://github.com/javitocor/Trekkie-World-Catalog/issues).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments 🚀

- [Microverse](https://www.microverse.org/)
- [React Documentation](https://reactjs.org/docs/getting-started.html)
- [Heroku Documentation](https://devcenter.heroku.com/)
- [Heroku Buildpack](https://github.com/mars/create-react-app-buildpack#user-content-requires)
- [Redux](https://redux.js.org/)
- [TVMaze API](http://www.tvmaze.com/api)

## 📝 License

This project is [MIT](lic.url) licensed.

[contributors-shield]: https://img.shields.io/github/contributors/javitocor/Trekkie-World-Catalog.svg?style=flat-square
[contributors-url]: https://github.com/javitocor/Trekkie-World-Catalog/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/javitocor/Trekkie-World-Catalog.svg?style=flat-square
[forks-url]: https://github.com/javitocor/Trekkie-World-Catalog/network/members
[stars-shield]: https://img.shields.io/github/stars/javitocor/Trekkie-World-Catalog.svg?style=flat-square
[stars-url]: https://github.com/javitocor/Trekkie-World-Catalog/stargazers
[issues-shield]: https://img.shields.io/github/issues/javitocor/Trekkie-World-Catalog.svg?style=flat-square
[issues-url]: https://github.com/javitocor/Trekkie-World-Catalog/issues