Giter VIP home page Giter VIP logo

nakamotoinstitute.org's Introduction

Satoshi Nakamoto Institute

NakamotoInstitute.org was written in Flask.

Guide to Installing SNI Locally

  1. Install python3 and virtualenv

  2. Copy config.py.env to config.py

  3. Update the domain assigned to SERVER_NAME in config.py if you would like to change "sni"

  4. If you are running the app locally, change FLASK_DEBUG in config.py to True in order to enable reloading of the server on code changes.

  5. Update your /etc/hosts file (replace sni with the value from step 3 if you changed it):

127.0.0.1     localhost
127.0.0.1     sni
127.0.0.1     satoshi.sni
  1. Download the PDFs and txts here and place them in sni/static/docs

  2. Set up a virtualenv with virtualenv -p python3 --no-site-packages venv and . venv/bin/activate

  3. Install the dependencies using pip install -r requirements.txt.

  4. Run mkdir tmp

  5. Run ./dataimport.py update. The db will be cleared and re-populated each time you do this. You can use the flags --content, and --skeptic to repopulate only models associated with the blog, the docs, and research docs, or skeptics, respectively.

  6. Run ./run.py runserver and navigate to sni:5000 in your browser.

Adding Mempool Translations

  1. Add proper markdown front matter:
translated_title: # Name of title in local language
translation_url: # Original URL for translation (optional)
translation_publication: # Name of original publication hosting translation (optional)
translation_publication_url: # URL of original publication hosting translation (optional)
  1. Place the markdown file in sni/templates/blog with the filename <slug>-<language ietf code>.md (e.g. speculative-attack-es.md).
  2. If you are a new translator, add your name and URL (i.e. website, Twitter, etc.) to data/translators.json.
  3. Update data/blogposts.json:
"translations": {
  "<local language code>": ["<translator name"]
}

Note: the name must match that in translators.json exactly.

  1. If you are submitting a new language, add it to data/languages.json.

How You Can Help

  • Format the HTML literature templates
  • Adjust the CSS and HTML to improve readability and navigation
  • Write tests for the Python code
  • Submit translations of website content (literature translations coming soon!)

NakamotoInstitute.org is under the GNU Affero License.

nakamotoinstitute.org's People

Contributors

0xbitman avatar albmontanez avatar benjamintuckerinstitute avatar bitstein avatar cd2357 avatar chloecaldasso avatar clashicly avatar danielkrawisz avatar dependabot[bot] avatar evd0kim avatar jtuwiner avatar justinmoon avatar llekn avatar marknugent avatar mertsa avatar mflaxman avatar pierrerochard avatar psztorc avatar ruiquelhas avatar scrambledeggsontoast avatar simong1080 avatar tombusby avatar vikbtc avatar wbnns avatar zachzager avatar

Watchers

 avatar

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.