Running locally

One of the core tenets of Neverkin is to be developer-friendly. As such, running the application locally should be simple, assuming you have the correct setup.

• Install Docker Desktop or your preferred flavor of Docker. You do not need to pay for it.
• Install Node.js if you don’t have it already.
• If you’re running Windows, I recommend using WSL2.

The main repository is located at https://github.com/tenebrie/neverkin. You can clone it using Git, or download it as a ZIP archive of the main branch. I recommend using Git to be able to receive updates.

After cloning or unzipping the repository, open your terminal and navigate to the repository root. Then, install the dependencies:

npm install

This may take a while the first time. Once it’s done, you can initialize the application:

npm run docker:preview

The preview mode starts the production version of the application with all dependencies handled locally.

Note that in this mode the application does not watch for code changes. If you want to work on the code and see your changes in real-time, use the following command instead:

npm run dev

In either mode, the setup will automatically go through the following steps (included here for reference):

• Create a new Docker Compose setup
• Build the containers locally
• Create a new database, stored in a Docker volume (on your local drive)
• Create a local S3 bucket (MinIO) that will be used for asset storage
• Run the database migrations
• Create a default admin user
  • Username: admin@localhost
  • Password: q
• Make the application accessible at http://localhost

Unless something goes wrong, you should have a fully working instance of Neverkin running locally. Your data will survive application restarts, and it’s stored locally on your machine.

In case you encounter any issues, please reach out through the Discord server or the Contact form.