Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benjaminch/app-store
https://github.com/benjaminch/app-store
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/benjaminch/app-store
- Owner: benjaminch
- License: mit
- Created: 2017-02-17T18:48:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-03-03T07:24:29.000Z (over 7 years ago)
- Last Synced: 2024-10-12T22:40:39.810Z (27 days ago)
- Language: Go
- Size: 160 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# App-store application
## Introduction
This application is a fake app-store search demo using [Algolia search](https://www.algolia.com/).
It's composed in two parts:
- A backend, written in Go
* [Sources](https://github.com/BenjaminCh/app-store/tree/master/backend)
- A frontend using [InfernoJS](https://github.com/infernojs/inferno)
* [Sources](https://github.com/BenjaminCh/app-store/tree/master/frontend)
## Table of content
1. **[Install](#install)**
* [Clone the code](#code)
* [Frontend (Yarn)](#frontend)
* [Backend (Go)](#backend)
1. **[Quick Start](#quick-start)**
* [Run Frontend](#run-frontend)
* [Run Backend](#run-backend)
1. **[Tests](#tests)**
* [Tests Frontend](#tests-frontend)
* [Tests Backend](#tests-backend)
1. **[Project](#project)**
* [What has been done so far?](#what-has-been-done)
* [What are the next steps?](#next-steps)
# Getting Started
## Install
### Code
Get the code on your machine cloning the repository.
```
git clone https://github.com/BenjaminCh/app-store.git
```
### Frontend
We will use [Yarn](https://yarnpkg.com) to run the frontend code (make sure you have it installed on your machine first).
Go in the repository (root level) and type the following commands:
```
cd frontend
yarn install
```
### Backend
We will use [Go](https://golang.org/) to run the backend code (make sure you have it installed on your machine first).
Go in the repository (root level) and type the following commands:
```
cd backend
go install
```
Now, we need to set Algolia's key and index in our configuration.
We need to specify it as environnement variable.
Example on Mac :
```
export APPSTORE_ALGOLIA_APPLICATIONID=[YOUR_APPLICATION_ID]
export APPSTORE_ALGOLIA_APIKEY=[YOUR_API_KEY]
```
There is also a way to specify those keys in the config file but for some reason (not found yet), the configuration doesn't seem to be taken into account when specified in the config file.
```
{
"version":"0.0.1.0",
"server":{
"port":"5000"
},
"application":{
"debug":false
},
"algolia":{
"applicationID":"[YOUR_APPLICATION_ID]",
"apiKey":"[YOUR_API_KEY]",
"indexes":{
"apps":"apps"
}
}
}
```
## Quick Start
### Run Frontend
We use [Yarn](https://yarnpkg.com) to launch locally our app.
Type the following command from the frontend folder:
```
yarn start
```
The server will start :
```
$ yarn start
yarn start v0.20.3
$ webpack-dev-server --quiet --config webpack.conf.js --host 0.0.0.0
Project is running at http://0.0.0.0:8080/
webpack output is served from http://localhost:8080/
Content not from webpack is served from ./
```
You can now go to http://localhost:8080/ and play with the app.
### Run Backend
We use [Go](https://golang.org/) to launch locally our app.
Type the following command from the backend folder:
```
go run *.go
```
The server will start.
You can now go to http://localhost:8080/ and play with the app.
#### Queries examples
##### Get an app from its identifier
```
curl -X GET "http://localhost:8080/api/1/apps/346374311"
```
Will produce :
```
{
"name":"Alaska Airlines",
"image":"http://a1.mzstatic.com/us/r1000/113/Purple/v4/78/29/10/78291078-1abf-e98b-668a-c4b8389c6746/mzl.vpxscteh.175x175-75.jpg",
"link":"http://itunes.apple.com/us/app/alaska-airlines/id356143077?mt=8",
"category":"Travel",
"rank":80
}
```
##### Create a new app
```
curl --data '
{
"name" : "WhatTheTVShow",
"image" : "static.whatthetvshow.com:9000/media/snapshots/c4c3021b168ba93572d402e313f0f884_medium.png",
"link" : "http://whatthetvshow.com",
"Category" : "Quiz",
"rank" : 223
}
' http://localhost:8080/api/1/apps
```
Will produce an HTTP 200 if object was created and will returns its ID.
##### Delete an app from its identifier
```
curl -X DELETE "http://localhost:8080/api/1/apps/362950001"
```
Will produce an HTTP 200 if ok, an HTTP 404 otherwise.
## Tests
### Tests Frontend
Tests to be added on the frontend.
### Tests Backend
We will use [Go](https://golang.org/) to test the backend code (make sure you have it installed on your machine first).
Go in the repository (root level) and type the following commands:
```
cd backend
go test ./...
```
## Project
### What has been done so far?
The following things has been done:
- [x] First backend version handling apps get / create and delete operations via REST
- [x] First frontend version playing with algolia search
- [x] Handle image 404 fallback to a default image (for apps that don't have images, or bad links)
- [x] Allow to reset a query
- [x] Query string
- [x] Facets
- [x] Pagination
- [x] Ranking (on app ranking desc)
### What are the next steps?
- [ ] Write frontend unit tests
- [ ] Setup Travis for continuous testing
- [ ] Encapsulate Algolia calls in a clean ServiceAPIComponent
- [ ] Encapsulate Imaginaary (custom image operations) calls in a clean ServiceAPIComponent
- [ ] Create a new index to be able to set a different custom ranking (for now we have only ranking desc)