Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 4.21 KB

README.md

File metadata and controls

53 lines (33 loc) · 4.21 KB
Raw

EternaJS

Eterna game/RNA design interface

Interested in development? Join the discusson on the Eterna Discord!

Eterna Discord

Setup

The project uses NPM for dependency management, webpack for packaging, and babel to polyfill ES2015 language features into ES5 and earlier.

  • Install npm (via nodejs):
  • $ npm install in root directory
  • Install and build the energy models via the instructions in lib/README.md. These are not included due to licensing restrictions.
  • If you want to modify any values in .env:
    • Create a file named .env.local and add any values from .env that you want to override.
    • You may want to use your actual username and password for DEBUG_PLAYER_ID and DEBUG_PLAYER_PASSWORD, instead of using EternaJS unauthenticated (i.e., as a guest user).
    • If you will be performing actions which cause data to be uploaded to our servers that could create inconsistencies, spam, or other potential problems, please leave APP_SERVER_URL as https://eternadev.org. If your changes are purely cosmetic, you may benefit from using https://eternagame.org instead.
    • If you are using eternadev, please note that this is using a clone of our production database. We wipe and re-clone it occasionally, but some times the time span we do this in may be longer or shorter. Depending on when we last cloned the DB and when you made your account, YOU MAY NOT YET HAVE AN ACCOUNT. Feel free to create one at http://eternadev.org. Additionally, make sure to back up anything you have on eternadev that you want to keep around.

Running tests

$ npm run test

Building and running

  • Compile and Serve:

    • $ npm run start

  • To do the first puzzle in Eterna, load up http://localhost:63343/?puzzle=4350940, and ask your browser to View JavaScript Console. To create your own test puzzles, check out the next section.

Setting up new test puzzles

  • Create your puzzle using the puzzlemaker GUI by clicking the "Create Puzzle" button at http://eternadev.org/web/playerpuzzles/

  • For functionality not available via the puzzlemaker, a puzzle can be directly set up via Drupal on the eternadev server through http://eternadev.org/node/add/puzzle and edited with http://eternadev.org/node/<id>/edit. Your login will need to have been granted Drupal admin access. We are working on a way to define and load puzzles locally, but until that time if you need a custom puzzle set up, let us know.

  • After you publish, you should be able to see the puzzle on the same player puzzles page, and figure out its ID by clicking on the puzzle.

Contributing

For introductory material to this codebase and the technologies it is built with, check out https://github.com/eternagame/development-bootcamp. If you're looking for somewhere to start contributing, check out our issues labelled good first issue.

  • Fork the repository

  • Make your changes in a separate git branch. In command line, use a command like git checkout -b myawesomefeature.

  • VS Code is a superb IDE for developing EternaJS, available for Mac & Windows. (Even Rhiju, a hardcore Emacs user, has converted.)

  • When you're ready to merge into master for deployment, create a pull request at https://github.com/Eternagame/EternaJS/pulls. We will then perform a code review.

Please note that for some reason or another, we may not approve of adding a feature you may have written. To avoid doing work we may reject later please open an issue and we will triage it and/or initiate discussion about the feature. That said, feel free to work on changes for your own experimentation. Eternascript boosters are also a great way to add in extra tools you want to see added, without needing us to consider whether or not that feature makes sense as a first-class citizen, or the specifics of how it needs to be implemented for a consistent user experience.

We also recommend joining our Discord to chat with other developers.