Git Product home page Git Product logo

RPNow

RPNow is a self-hosted, web-based roleplay chat website.

(TODO: add a GIF here!)

Running RPNow

For non-technical users who just want to deploy a server, there is a helpful guide here!

However, if you're interested in building the project from source, or modifying the server, read on.

Build Requirements

Building

If you have GNU Make installed, then simply open a shell in the project root and run make.

Otherwise, you can execute the individual steps manually:

# Build the web frontend
cd views
npm install
npm run build

# Build the server
cd ../server
go build -o ../rpnow

# The built server executable will now be at the project root
cd ..

Developing

For a fast and pleasant development experience, it's nice to be able to rebuild and reload the server every time you change a source file. To do that for RPNow, run these two things:

  • Web Frontend: Open a shell in the "views" directory. If you haven't already run npm install, do that first. Then, run npm run watch, which will watch and rebuild the JavaScript.
  • Server Backend: Open a shell in the "server" directory. Make sure you have installed Nodemon (npm install --global nodemon) and then run nodemon. This will keep the server running at http://localhost:13000.

State of the project

RPNow is more-or-less feature-complete. While it's possible that I may add features in the future, it is quite likely that the project will remain dormant for months or years.

If I become aware of any security issues, I will try to address them in a timely manner.

License

See LICENSE

Acknowledgments

Browserstack
Cross-browser testing provided by Browserstack.

RPNow's Projects

rpnow icon rpnow

The Do-It-Yourself Roleplay Chat Solution

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.