Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matitalatina/pokespeare-frontend
https://github.com/matitalatina/pokespeare-frontend
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/matitalatina/pokespeare-frontend
- Owner: matitalatina
- Created: 2020-07-18T14:46:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-12T02:02:10.000Z (about 1 year ago)
- Last Synced: 2024-11-11T18:18:06.157Z (2 months ago)
- Language: TypeScript
- Size: 729 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PokéSpeare Frontend
## Requirements
- [Node.js 12](https://nodejs.org/).
- [Docker](https://www.docker.com/): if you want to start inside docker.
## Getting started
Add `REACT_APP_BACKEND_URL=` environment variable to point API calls to the backend.
After that, see the available scripts below.
## Notes
- All the business logic is tested using [TDD](https://en.wikipedia.org/wiki/Test-driven_development).
- I created the components using [Atomic Design Methodology](https://bradfrost.com/blog/post/atomic-web-design/).
- I used [InversifyJS](https://github.com/inversify/InversifyJS) to achieve [Inversion of Control](https://en.wikipedia.org/wiki/Inversion_of_control), this simplified testing and help to build decoupled classes.
- I used only functional components. To manage the state I used [hooks](https://en.reactjs.org/docs/hooks-intro.html).
- In `.env` you can change the backend URL.
- This repo has Continuous Deployment enabled. Every push on master goes straight to [https://pokespeare.mattianatali.dev/](https://pokespeare.mattianatali.dev/). I used [netlify](https://www.netlify.com/) to do that.
- If you want to see the full picture, please see the [docker compose repository](https://github.com/matitalatina/pokespeare-docker).
- The `Dockerfile` uses multi-stage builds to optimize space.
## Docker
If you want also the backend, please see the [PokéSpeare docker repository](https://github.com/matitalatina/pokespeare-docker).
```bash
# Build
docker build . -t pokespeare-frontend --build-arg 'REACT_APP_BACKEND_URL='
# Run
docker run -p 80:80 pokespeare-frontend
```
## Available Scripts
In the project directory, you can run:
### `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 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!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.