lovvedit

Media recommendation website.

Table of Contents

• Introduction
• Getting Started
  • Requirements
  • Installation
• Setting Up Development Environment
• Testing
• Contributing
• FAQ
• Maintainers
• License

Introduction

lovvedit is a website to recommend others stuff (books, movies, tv shows, etc) you, well, loved. So, for example, when you run out of shows to binge-watch, you can go here and read what other people enjoyed and maybe give those things a try.

Getting Started

Requirements

You'll need Docker, Docker Compose and Git installed in your machine for development.

Installation

Clone the repo and build the Docker containers:

git clone https://github.com/lovvedit/lovvedit.git
cd lovvedit
docker-compose build

Setting up Development Environment

Generate the file with environmental varibles:

scripts/gen_env_file

This will create a file .env in the project root directory. Some variables are left blank on purpose. Fill manually the empty variables.

Start the application:

docker-compose up

Now the application should be listening on port 80. Go to http://api.localhost/graphiql and check that you see the GraphiQL page.

Installing Node dependencies on host system

To make use of linters and other development tools, you must yarn install on your machine. Don't worry, the node_modules folder inside the container and the one in your machine won't cause any trouble.

Testing

You can test the application inside the Docker container with:

docker-compose exec node yarn test

Contributing

See CONTRIBUTING.md

FAQ

Maintainers

Current maintainers:

• Diego Stratta <strattadb@gmail.com>

License

MIT