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

https://github.com/jefer94/reign-challenge


https://github.com/jefer94/reign-challenge

Last synced: 7 days ago
JSON representation

Awesome Lists containing this project

README

        

# Run

```bash
yarn docker:build
docker-compose up -d
```

# Todo

## General

- [X] Small web application
- [X] Wireframe
- [X] The app should have two separate components: the Server and the Client
- [X] Lists the articles in chronological order

## Server

- [X] Once an hour, save https://hn.algolia.com/api/v1/search_by_date?query=nodejs to Mongo
- [X] Rest API

## Client

- [X] Sort by date (most recent first)
- [X] Can delete one post forever

## Stack

- [X] Express/Koa
- [X] Angular + Angular Material or React + Material-ui

## Considerations

- [X] Node.js version >= 8
- [X] At least 30% test coverage (statements) for the server component
- [X] The whole project has to be uploaded to GitLab
- [X] Both artifacts (server and client) have to be Dockerized
- [X] To start the project there should be a docker-compose that uses both images and the
MongoDB image

## Extras

- [X] Tests and linters should be run on a GitLab pipeline (gitlab-ci.yml)
- [ ] Docker multi-stage build

## Docs

- [X] README.md
- [X] Add instruction to run it