Development & Contributing

Development

To develop locally, you'll need Node.js 12 and npm installed. You will also likely need a rhobooru server running somewhere to develop against.

1. Clone the repository

git clone https://github.com/rhobooru/rhovue
cd rhovue

2. Make sure you're on the dev branch

git checkout dev

3. Install the project dependencies

npm run install

4. Create a .env file

cp .env.example .env

5. Start the hot-reload dev server

npm run dev

6. Navigate to http://localhost:3000. Changes made to the source files will automatically be reflected in the open browser window.

Configuration

BASE_URL

This is the URL that rhovue will be running under. By default, it's http://localhost:3000 (the default for Nuxt's npm run dev and npm run start commands).

GRAPHQL_ENDPOINT

This should be the endpoint serving the rhobooru GraphQL API you're going to develop against. By default, it's http://127.0.0.1:8000/graphql, which should match a default rhobooru server running with php artisan serve (PHP's built-in web server).

Testing

Tests can be run with

npm run test

---

Contributing

Environment

VS Code

For ease, a *.code-workspace configuration file is provided to conform with the project's standards.

If using VS Code, it's recommended that you install the ESLint and Vetur extensions for the workspace. Vetur will enable Vue support and ESLint will make it easy to conform to the project's coding standards.

Go to File > Preferences > Settings > Workspace > Extensions > Vetur and uncheck Format: Enable to prevent Vetur from trying to run its own formatters. Then go up to ESLint and set Eslint > Code Actions On Save: Mode to all to automatically fix ESLint issues on file save.

// TODO