NodeWorldOfText: Difference between revisions

From Our World of Text Wiki
Jump to navigation Jump to search
← Older editNewer edit →
Visual
Dat Hack3r (talk | contribs)
editor
1,336 edits
Update of NWOT status and section renaming.
Dat Hack3r (talk | contribs)
editor
1,336 edits
m →Hosting an NWOT: Fixed SyntaxHighlighting errors by switching to HTML syntax.
Line 10: Line 10:


=== Quickstart ===
=== Quickstart ===
* Clone the OWOT repository
<ul>
*: <syntaxhighlight lang="bash" inline>git clone https://github.com/system2k/nodeworldoftext.git nwot</syntaxhighlight>
  <li>Clone the OWOT repository
* Navigate to the directory
    <ul><li><syntaxhighlight lang="bash" inline>git clone https://github.com/system2k/nodeworldoftext.git nwot</syntaxhighlight></li></ul>
*: <syntaxhighlight lang="bash" inline>cd nwot</syntaxhighlight>
  </li>
* Install the dependencies
  <li>Navigate to the directory
*: <syntaxhighlight lang="bash" inline>npm install</syntaxhighlight>
    <ul><li><syntaxhighlight lang="bash" inline>cd nwot</syntaxhighlight></li></ul>
* Run the server
  </li>
*: <syntaxhighlight lang="bash" inline>node main.js</syntaxhighlight>
  <li>Install the dependencies
* Running the server for the first time, you'll be asked to configure the settings.  
    <ul><li><syntaxhighlight lang="bash" inline>npm install</syntaxhighlight></li></ul>
*: <syntaxhighlight>Created the settings file at [../nwotdata/settings.json]. You must configure the settings file and then start the server back up again.
  </li>
Full path of settings: [path to parent directory]/nwotdata/settings.json</syntaxhighlight>
  <li>Run the server
* After configuring the settings, run the command again. Note that this will create an <code>nwotdata</code> directory on the same level as your repository.
    <ul><li><syntaxhighlight lang="bash" inline>node main.js</syntaxhighlight></li></ul>
*: <syntaxhighlight lang="bash" inline>node main.js</syntaxhighlight>
  </li>
* You will then be prompted to create a superuser account with this message:
  <li>Running the server for the first time, you'll be asked to configure the settings.
*: <syntaxhighlight>You've just installed the server,
    <ul><li><pre>Created the settings file at [../nwotdata/settings.json]. You must configure the settings file and then start the server back up again.
Full path of settings: [path to parent directory]/nwotdata/settings.json</pre></li></ul>
  </li>
  <li>After configuring the settings, run the command again. Note that this will create an <code>nwotdata</code> directory on the same level as your repository.
    <ul><li><syntaxhighlight lang="bash" inline>node main.js</syntaxhighlight></li></ul>
  </li>
  <li>You will then be prompted to create a superuser account by this message:
    <ul><li><pre>You've just installed the server,
which means you don't have any superusers defined.
which means you don't have any superusers defined.
Would you like to create one now? (yes/no):</syntaxhighlight>
Would you like to create one now? (yes/no):</pre></li></ul>
* After everything has been set up, your server will be live at this address:
  </li>
*: <code>http://localhost:8080</code>
  <li>After everything has been set up, your server will be live at this address:
    <ul><li><code>http://localhost:8080</code></li></ul>
  </li>
</ul>


=== Common issues ===
=== Common issues ===

Revision as of 11:42, 2 April 2025

NodeWorldOfText is the open source version of OWOT, which anyone can view, download, and contribute to by opening issues and pull requests. It allows users to host their own instance of Our World of Text called an NWOT.

Hosting an NWOT

Software requirements

Quickstart

  • Clone the OWOT repository
    • git clone https://github.com/system2k/nodeworldoftext.git nwot
  • Navigate to the directory
    • cd nwot
  • Install the dependencies
    • npm install
  • Run the server
    • node main.js
  • Running the server for the first time, you'll be asked to configure the settings. 
    • Created the settings file at [../nwotdata/settings.json]. You must configure the settings file and then start the server back up again.
Full path of settings: [path to parent directory]/nwotdata/settings.json
  • After configuring the settings, run the command again. Note that this will create an nwotdata directory on the same level as your repository.
    • node main.js
  • You will then be prompted to create a superuser account by this message: 
    • You've just installed the server,
which means you don't have any superusers defined.
Would you like to create one now? (yes/no):
  • After everything has been set up, your server will be live at this address:

Common issues

  • If you're encountering issues with nwot_error_logs.zip, please delete the zip file and try again.
  • If you're receiving node-gyp errors while installing the modules via NPM, please ensure you've got some compiling tools installed on your system. If you have any further questions, feel free to ask on the Discord.
  • If you're receiving an error saying Cannot find module, make sure you've installed the modules by running npm install.

Currently active NWOTs

There are currently no active NWOTs. See below.

Inactive or discontinued NWOTs

Hosting an NWOT on Replit

It used to be possible to host NWOT on Replit's free web hosting service. This could be accomplished by importing KKosty4ka's NodeWorldOfText fork to Replit and running the for-repl-it branch, which would host the NWOT at https://[repl name].[user name].repl.co. However, Replit's hosting changes effectively discontinued all NWOTs hosted on their platform.

Former NWOTs Hosted on Replit

Below is a list of now-defunct NWOTs that were hosted using Replit.

Retrieved from "https://wiki.ourworldoftext.com/index.php?title=NodeWorldOfText&oldid=8565"