Giter Club home page Giter Club logo

home-library's Introduction

README

This README would normally document whatever steps are necessary to get the application up and running.

Things you may want to cover:

  • Ruby version

  • System dependencies

  • Configuration

  • Database creation

  • Database initialization

  • How to run the test suite

  • Services (job queues, cache servers, search engines, etc.)

  • Deployment instructions

  • ...

home-library's People

Contributors

arlindohall avatar

Watchers

 avatar

home-library's Issues

Add export/import functionality

Purpose

I want to be able to click a button and get the full data for myself as a fast compressed download, and with one button put that file back into the db. That's because this is in digital ocean, if I accidentally brick something I want to not have to manually scan my books again.

Description

I think this might be possible as a simple API but also I know rails has something like file downloads.

The controller could create a downloadable file and save the name to the user table, and then download when ready.

Index books table on scanned id

Purpose

Be able to quickly look up books when an id is scanned. The lookup already happens, this will just make it fast.

Description

Just create a migration for a new index.

Create readme with instructions for usage/setup

Purpose

Getting started should be as easy as running one script, but also it would be nice if there were some instructions.

Description

The readme should explain how to install dependencies and run the project as well as... anything else that goes in a readme? I actually don't have great ideas here.

Remove credentials file (currently in dotfiles)

Background

This project should run easily with the server setup logic in my dotfiles repo. Part of that is making the whole thing run on docker with as few files mapped as possible. I already (I think) set it up to pull the secret key base as an env variable, but I think if I pass in the master key instead it can encrypt the secret key base... or maybe it's the other way around?

I remember googling about it but I lost the links and forgot what the plan was. The below section is old and I don't remember what it means.

Ultimately the purpose of this is so that the thing runs in docker and can be wrapped with a script and still get the needed secret keys to be consistent between deployments to the same server.

Description

Remove the credentials file, pass in secret_key_base as an environment variable, and remove master.key if possible.

While doing this, add the docker-run.rb script back and have the dot files repo that consumes it copy it to the current directory.

Add authentication and authorization for scanning books

Background

I want to deploy this to digital ocean and scan my books there, but I'd like to be able to not have random input data or read about my books.

Description

All pages except login should return the login page unless there is an authorized user. Also APIs should verify the session.

image

Tasks

  • Add a helper method to the base controller that redirects unless logged in

Add search controller/functionality

Background

I'd like to be able to search by title, author, and description all at once, preferably with a fuzzy search. I think I remember SQLite supporting some kind of search.

Description

Add whatever kind of index is needed to do full text search on SQLite.

Example

Add index of books in genre to genre page

Background

Part of the explore feature is that you can go to the page for any given genre and see all the books there.

Description

Update the genre page (not sure if one exists or not) to fetch books by genre. That also means updating the books index api to take a genre parameter and filter it out. That would probably also be improved by adding an index by genre/id or genre/scanned_id.

Move from SPA style to true MVC

This seems sort of daunting but it'll be easier while the app is smaller before I add more features. And the app already behaves more like rails.

It should be made a lot easier using this css framework I just learned about Simple.css.

Add pagination to books controller

Purpose

The page should scale to a big frickin library. But also I think I've got like a thousand books and that might actually not be too slow. I should scan all mine in and see if it's slow, and add pagination later.

Description

  • add will paginate gem
  • paginate the json renderer (is that possible without an erb template?)

Add script for setting up ssl

Background

I want to be able to get as close as a one click deployment to digital ocean as possible. As part of that, I'd like to be able to run a script once the dns is set up and just enable ssl.

Description

I can never remember the cert bot commands to enable ssl, so I think if I just add a script that runs once Nginx is set up that enables ssl using a url validation that would be perfect.

Related

Also remove server setup for this and for the home server from dot files and move it to its own project

Add dropdown to app bar that opens navigation menu

Description

The hamburger is already there, there just needs to be a state opened or closed and a menu that hides or is visible based on that. The menu just goes to the main pages (books index, profile, logout, scan)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.