budet-b / Bookr

πŸ“š Book manager and social network cross platform mobile app.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Banner

Book'R is a bookmark manager for iOS and Android that allows the user to log his advancement in books and compare his reading progress with his friends.

This project was made for the JS course of 4th year in the Multimedia and Information Technology major at EPITA.

By:

  • Benjamin Budet (budet_b) - budet-b
  • Alexandre Toubiana (toubia_b) - alextoub

Requirement

The platform

BookR

You can access to the API here hosted on heroku

Installation

Backend

Database (PostgreSQL)

  1. Get into the backend/db folder.
  2. Create the database
$ pg_ctl start
$ psql postgres -c "CREATE DATABASE bookr"
  1. Get into the database using postgreSQL
$ psql bookr
  1. Initalize and seed the database.
bookr=# \i ./init_db.sql
bookr=# \i ./datas.sql

API (NodeJS)

  1. Get into the backend/api folder.
  2. Install and start the project
$ npm install
$ npm start
  1. You can now access the API on http://localhost:8080

Frontend (React Native)

  1. Get into the frontend/Bookr folder.
  2. Install and start the project
$ npm install
$ npm start
  1. Launch the app on simulator or by scanning the QR Code to open the app on Expo on your device.

About

πŸ“š Book manager and social network cross platform mobile app.


Languages

Language:JavaScript 94.8%Language:CSS 4.0%Language:HTML 1.0%Language:Shell 0.3%