rodrigojimenezdencker / rick-morty

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rick & Morty App

This is a example of an React/Redux + Express + MongoDB application. It also fetches data from an external api at https://rickandmortyapi.com.

The repository has the frontend app and the backend API. You will find each of its implementations in the client and api folder respectively. Each folder contains a brief explanation of the architectural design decisions and project structure.

Quick Start

To run the app with Docker

  • Install Docker in your local machine
  • Run
git clone https://github.com/nurruty/rick-morty.git
cd rick-morty
docker-compose up

Manual installation

If you prefer to run the client and api manually, first you will have to provide a series of env variables. In the .env.dev file you will find the examples. Also you will need to have some MongoDB instance running and fill the DATABASE_URL env variable with the Mongo's connection url.

At this point the app does not have a SignUp feature, so you will have to seed the database yourself with some test users.

After all that is done just run:

cd client
npm install
npm run start

and for the API, in a new terminal run

cd api
npm install
npm run start

Test Users

The Docker installation comes with 2 seeded users:

Further work

  • Add more tests
  • Signup page
  • Image caching

About

License:MIT License


Languages

Language:JavaScript 88.6%Language:SCSS 7.7%Language:HTML 2.2%Language:CSS 0.7%Language:Dockerfile 0.5%Language:Pug 0.3%