https://github.com/sfatihk/marvel
Marvel Box 🦸♂️🦸♀️🦹♂️🦹♀️
https://github.com/sfatihk/marvel
marvel react reactjs redux redux-toolkit sass typescript
Last synced: 8 months ago
JSON representation
Marvel Box 🦸♂️🦸♀️🦹♂️🦹♀️
- Host: GitHub
- URL: https://github.com/sfatihk/marvel
- Owner: sfatihk
- Created: 2021-09-28T21:24:29.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-30T13:09:32.000Z (about 4 years ago)
- Last Synced: 2025-01-15T14:16:37.183Z (9 months ago)
- Topics: marvel, react, reactjs, redux, redux-toolkit, sass, typescript
- Language: TypeScript
- Homepage: https://marvelbox.netlify.app
- Size: 1.36 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MARVEL BOX 🦸♂️🦸♀️
Website using marvel APIs. It lists Marvel's characters & their comics.
### 👉 [Live Preview](https://marvelbox.netlify.app)
## Specification
#### System Specification
- Node: 14.17.6
- npm: 7.22.0
#### .env Variables
You need to Marvel Developer Account (https://developer.marvel.com)
- `REACT_APP_MARVEL_SERVER_URL` : Marvel api gateway url (https://gateway.marvel.com/v1/public)
- `REACT_APP_MARVEL_PUBLIC_KEY` : Marvel developer account public key
- `REACT_APP_MARVEL_PRIVATE_KEY` : Marvel developer account private key
## Setup Steps
Install package with `yarn`
Copy example environment `cp .env.example .env`
Fill blank fields on `.env`
Start the project with `yarn start`
Test the project `yarn test`
## Structure
├────── **assets** : images & styles resources
├────── **components** : pure components
├────── **config** : api configurations
├────── **containers** : complex components with store access
├────── **layout** : layout components & template
├────── **screens** : main screens
├────── **services** : requests and api services
├────── **store** : store, reducers & state management config
├────── **types** : typescript type definition
├────── **utils** : other utilized functions