mirror of
https://github.com/indentlabs/notebook.git
synced 2025-10-26 11:19:22 +00:00
69 lines
2.7 KiB
Plaintext
69 lines
2.7 KiB
Plaintext
Indent
|
|
|
|
Indent 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, including areas like:
|
|
- Automated revision services
|
|
- Structuring real-time natural language processing output into a 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
|
|
|
|
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. :)
|
|
|
|
There are a ton of milestones that comprise a massive amount of feature creep, but represent the areas I see Indent
|
|
moving into and benefiting writers, designers, programmers, and many others greatly! They have no timelines and are all
|
|
in development simultaneously; feel free to jump around to wherever interests you most. They are split into completely
|
|
independent milestones that do not affect each either, so whichever ones the developers want to work on first will be
|
|
completed first.
|
|
|
|
To install the Indent stack on a new machine:
|
|
- Install curl
|
|
|
|
sudo apt-get install curl
|
|
|
|
- Install rvm
|
|
|
|
\curl -sSL https://get.rvm.io | bash
|
|
source /home/drusepth/.rvm/scripts/rvm
|
|
|
|
- Install ruby 1.9.3
|
|
|
|
rvm install ruby 1.9.3
|
|
|
|
- Install rails
|
|
|
|
gem install rails
|
|
|
|
- Install mongodb
|
|
|
|
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 7F0CEB10
|
|
echo 'deb http://downloads-distro.mongodb.org/repo/ubuntu-upstart dist 10gen' | sudo tee /etc/apt/sources.list.d/mongodb.list
|
|
sudo apt-get update
|
|
sudo apt-get install mongodb-10gen
|
|
|
|
- Install gems
|
|
|
|
bundle install
|
|
|
|
You can run the rails server with
|
|
$ rails server
|
|
|
|
To set up the Indent workspace on a new machine:
|
|
- Clone Indent repo from GitHub
|
|
- git remote add heroku <heroku url.git>
|
|
|
|
To view the live stage of this project, visit it (and feel free to use it!!) at:
|
|
- http://indentapp.com
|
|
|
|
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)
|
|
- run regression tests on staging environment (idential to live)
|
|
- deploy to live (viewed at indentapp.com)
|
|
|
|
Feel free to get in touch if you have any questions, comments, or concerns! :)
|