Oil & Rope Tabletop

React project which manages the visual and interactive part of Oil & Rope, which includes a chat and the tabletop itself.

• Oil & Rope Tabletop
  • Installation
    • QuickStart
    • Backend
      • From Project
      • Create admin user
    • Frontend

Installation

In order to have the full project working you'll need to either bypass the login system and mock fetch responses or the easy way by setting up the backend and frontend as separate projects.
Let's do the easy way.

QuickStart

1. Install Docker.
2. Run the command below.
3. Run docker run -ti oar_core poetry run ./manage.py createsuperuser.
   1. Set username, email and password.
4. Access localhost:8000.
5. Run npm i -D
6. Run npm start
7. Access localhost:8080.

# Download the project image at it latest development version

docker pull oilandrope/core:develop

# Execute this command to setup the backend as Docker container

docker run \
--tty --interactive \
--env=DJANGO_SETTINGS=oilandrope.dev_settings \
--env=GUNICORN_WORKERS=1 \
--publish=127.0.0.1:8000:8000 \
--name=oar_core \
oilandrope/core:develop

Backend

In order to start development you'll need node 16.x or superior and probably a copy of the Oil & Rope Project either running directly from virtual environment or using Docker.

From Project

If you want a to control and debug everything you can set up the backend directly from the GitHub Project following the Installation Guide but keep in mind the if you want to work with the chat you'll need to Setup Channels.

Create admin user

If you created a docker container you'll need to open a new terminal and run docker exec -ti oar_core bash this will create a bash terminal inside the container so you can execute any command you want.
For creating a superuser user just run python ./manage.py createsuperuser and set Username, Email and Password as requested.

If you are running the project just run python ./manage.py createsuperuser (inside the virtual environment if you created one) and set Username, Email and Password.

Then you'll be able to access localhost:8000.

Frontend

Once you have cloned the repository (git clone https://github.com/oil-rope/oilandrope-tabletop) access the folder (cd oilandrope-tabletop) and execute npm i -D (any change made on package-lock.json because of this command should be ignored).
Once the installation is complete just run it by using npm start.

Now you should be able to access localhost:8080.