Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/alexsomai/askify

Real-time web application made with React, Redux, Express and RethinkDB 🙋🏻‍♂️
https://github.com/alexsomai/askify

nodejs react redux rethinkdb

Last synced: 16 days ago
JSON representation

Real-time web application made with React, Redux, Express and RethinkDB 🙋🏻‍♂️

Awesome Lists containing this project

README

        

# Askify

[![CircleCI](https://circleci.com/gh/alexsomai/askify/tree/master.svg?style=svg)](https://circleci.com/gh/alexsomai/askify/tree/master)

## About

A question based real-time web application made with React, Redux, Express and RethinkDB. 🙋🏻‍♂️

## Demo
[![Askify demo](https://i.imgur.com/o8WJnJN.png)](https://vimeo.com/385663525 "Askify demo (click to watch)")

## Application Architecture

### Overall Architecture
![Overall Architecture](docs/application-architecture.png)

### Client Side Architecture
![Client Architecture](docs/client-architecture.png)

## Installation

**Step 1.** [Install RethinkDB](https://www.rethinkdb.com/docs/install/).
**Step 2.** Install [Node.js](https://nodejs.org/) v8 (or newer).

## Start locally

**Step 1.** [Start RethinkDB](https://www.rethinkdb.com/docs/start-a-server/):

```shell
$ rethinkdb
```

**Step 2.** Clone this repository:

```shell
$ git clone [email protected]:alexsomai/askify.git
$ cd askify
```

**Step 3.** Start the server application.

    **Step 3.1.** Install dependencies:

```shell
$ cd server && npm install
```

    **Step 3.2.** Start the server:

```shell
$ cd server && npm start
...
==> 🌎 Server Listening on port 3001. Open up http://localhost:3001/ in your browser.
```

**Step 4.** Start the client application.

    **Step 4.1.** Install dependencies:

```shell
$ npm install
```

    **Step 4.2.** Start the client:

```shell
$ npm start
...
==> 🌎 Listening on port 3000. Open up http://localhost:3000/ in your browser.
```

**Step 5.** Open the application.

Access http://localhost:3000/ in your browser, and enjoy 🙂.