NodeWorldOfText: Difference between revisions

(5 intermediate revisions by 2 users not shown)

Line 1:

[https://github.com/system2k/nodeworldoftext 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'''.

[https://github.com/system2k/nodeworldoftext NodeWorldOfText] is the open source version of [[OWOT]], which anyone can view, download, and [[Contributing|contribute]] to by opening issues and pull requests. It allows users to [[Running from source|host their own instance]] of Our World of Text called an '''NWOT'''.

== Hosting an NWOT ==

Line 10:

=== Quickstart ===

* Clone the OWOT repository

<ol>

*: <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>

* 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.

*: <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.

</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.

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>

</ol>

=== Common issues ===

Line 36:

Line 46:

== Currently active NWOTs ==

~~There are currently no active NWOTs~~. ~~See below~~.

* My World of Text

** URL: https://web.myworldoftext.com/

== Inactive or discontinued NWOTs ==

Line 58:

Line 70:

[[Category:Articles nominated by Guest-1052]]

[[Category:Documentation]]