Notebook.ai is a set of tools for writers, game designers, and roleplayers to create magnificent universes – and everything within them.
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create ISSUE_TEMPLATE.md Nov 6, 2016
app potential fix for touchscreen devices reordering Jan 16, 2019
bin rake rails:update Jul 5, 2018
config Merge branch 'master' into jan-15-bugfix-release Jan 16, 2019
db hook up attribute category sort backend Jan 9, 2019
docs ALL the page types Nov 1, 2018
features fix feature tests Sep 1, 2018
lib code cleanup Sep 17, 2018
log Merge resolution Mar 14, 2015
public potential fix for touchscreen devices reordering Jan 16, 2019
script add script for migrating content between users Jan 9, 2019
spec test deprecations Sep 8, 2018
test ALL the page types Nov 1, 2018
vendor/assets Optimize javascript load times Nov 3, 2016
.coveralls.yml Create coveralls config file Mar 14, 2015
.editorconfig Create editorconfig file Sep 21, 2016
.gitignore Use rspec-prof Oct 2, 2016
.rspec Install rspec Sep 29, 2016
.rubocop.yml Fix Rubocop config capitalization Aug 26, 2016
.ruby-version Modernize ruby, bundler, and several gems Jun 6, 2018
.tool-versions update .tool-versions Jul 24, 2018
.travis.yml Update app name in travis deployment config Feb 6, 2017
CHANGELOG.md Move all changelog info into GitHub Releases Nov 6, 2016
Dockerfile Update ruby versions Jun 28, 2018
Gemfile Merge pull request #320 from indentlabs/jan-15-gem-upgrades Jan 16, 2019
Gemfile.lock Merge pull request #320 from indentlabs/jan-15-gem-upgrades Jan 16, 2019
Guardfile Rubocopification Sep 2, 2015
LICENSE.rdoc Add MIT license Sep 30, 2016
Procfile add sidekiq config Dec 4, 2018
README.rdoc Add billing_plans:initialize_defaults to README (fixes #317) Jan 9, 2019
Rakefile add devise secret Apr 7, 2016
app.json Remove unnecessary dependencies for app.json/staging Sep 29, 2017
config.ru Rename app internally from PlanCharacters to Notebook May 23, 2017
docker-compose.yml use 'bundle's version of 'rails' May 23, 2018

README.rdoc

Notebook.ai

Build Status Inline docs

What is Notebook.ai?

see live website

notebook is a set of tools for writers, game designers, and roleplayers to create magnificent universes – and everything within them.

From a simple interface in your browser, on your phone, or on your tablet, you can do everything you'd ever want to do while creating your own little (or big!) world.

notebook is a writer's planning tool for creating anything from universes to characters, to plots, to individual items.

It is also meant to expand into many areas to benefit writers (and exciting to developers), including areas like:

  • Automated revision services

  • Structuring real-time natural language processing output into a semantically reusable state

  • Decision-making algorithms for improving reading comprehension, reading level, accent-correction, and other real-time writing suggestions

  • A knowledge graph of structured data in your universe, and an engine to manipulate it in awesome ways

  • Machine learning on generating character and location names, suggesting realistic defaults (random or not), and more

  • and tons more

The Issue Tracker

If you are interested in helping out, check out the issue tracker. I've loaded it with tons of action-based, chunk-sized improvements that I think anyone familiar with Rails will be able to jump in and complete. Feel free to make suggestions, open issues, join discussions, or ask where you should look in the code to get started implementing something. :)

You'll notice there are *a lot* of issues in *a lot* of milestones. Call it feature creep, but I've separated every potential idea for full-fledged services into milestones that can be worked on completely independently of others. The features are (for the most part) has no deadlines and are in development simultaneously, meaning if you see a feature you would really like to use, you can make that feature happen by jumping directly into it and completing its issues.

TL;DR Milestones are independent of each other – work on whatever you want to see made!

Installing the notebook development stack locally

Install ruby 2.5.1 (using `rbenv`, `rvm`, any other Ruby version manager, or just plain ol' ruby)

rbenv install 2.5.1

Install necessary libraries

sudo apt install imagemagick libmagickwand-dev
sudo apt install libpq-dev

Clone the code

git clone git@github.com:indentlabs/notebook.git

Install gems

bundle install

Create database

rake db:create

Run initial database migrations

rake db:migrate
rake billing_plans:initialize_defaults
rake data_migrations:create_default_billing_plans
rake db:seed

Finally, run the server with

bundle exec rails server

You should now see a copy of the site running locally at localhost:3000/!

Running the notebook stack locally with Docker

  • install Docker

  • install Docker Compose

  • clone this git repo

  • cd into the root of this repo, and then run

    docker-compose up
  • You should now see a copy of the site running locally at localhost:3000/

Deployment to notebook.ai

Deployment to the live stage will only be done by approved developers, and consists of a deployment of

  • deploy github to staging (done only by approved developers)

  • mirror data from live into staging

  • run regression tests on staging environment

  • deploy from staging to live (viewed at notebook.ai)

Thanks

Feel free to get in touch if you have any questions, comments, or concerns! :)

© Andrew Brown 2016