spoti-search/README.md

27 lines
886 B
Markdown
Raw Normal View History

2020-07-22 09:57:07 +00:00
# Spoti Search
2020-08-02 23:05:14 +00:00
2020-08-02 22:42:46 +00:00
A react application using typescript showing the albums of an artist the user is searching for using a GraphQL endpoint.
2020-07-22 09:57:07 +00:00
2020-08-02 23:05:14 +00:00
- Deployed app: https://ruihildt.github.io/spoti-search/
- Endpoint: https://spotify-graphql-server.herokuapp.com/graphql
2020-08-02 22:42:46 +00:00
## Using the app
### Installation
2020-08-02 23:05:14 +00:00
1. Clone the git repo [from here](https://github.com/ruihildt/spoti-search).
2. Install libraries using yarn (can also be run with npm): `yarn install`
### Usage
2020-08-02 23:05:14 +00:00
- Run the app: `yarn start`
- Build the app to deploy it: `yarn build`
- Run the tests: `yarn test`
2020-08-02 22:42:46 +00:00
## Tech Stack
2020-08-02 23:05:14 +00:00
- [CRA with Typescript](https://create-react-app.dev/docs/adding-typescript/)
- [Apollo / GraphQL](https://www.apollographql.com/docs/react/)
- [Grommet](https://v2.grommet.io/) (an accessible framework/component library for react)
- [Lodash](https://lodash.com/) (for debouncing the query)