Skip to content

A Book database to manage what have you read. Build in Flask and React. To be deployed in Balena Cloud

License

Notifications You must be signed in to change notification settings

JavierRibaldelRio/Books-Database

Repository files navigation

Books Database

An app to manage the books that you have read. CS5Ox final project.

Getting Started

Prerequisites

  • NPM & Node.JS installed
  • Pip & Python installed

Installing

Frontend

All this commands must be executed in /frontend/

  1. Install npm packages
frontend/$ npm install

Then for development purpose, add this line in /frontend/package.json

{
...
    "proxy":"http://127.0.0.1:5000/",
...
}
  1. Run this command
frontend/$ npm start

Backend

All this commands must be executed in /backend/

  1. Create python virtual environment
/backend/$ sudo python -m venv flaskenv
  1. Access to virtual environment
/backend/$ source flaskenv/bin/activate
  1. Install pip packages
(flaskenv)/backend/$ sudo pip install -r requirements.txt
  1. Start the backend server
(flaskenv)/backend/$ flask run

Deployment

  • For deployment purpouse be sure to remove proxy line in /frontend/package.json
  • Execute this command in /frontend/
npm run buid

Built With

  • React - The web framework used
  • Flask - Backend server
  • D3 - Used to generate plots

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details