πŸ› οΈ VitNode is still in development! You can try it out, but it is not recommended to use it now in production.

Developer Mode

This guide will help you to install the project on your local machine.

❌

This tutorial is for development purposes only. Do not use these credentials in production.

πŸ“ Prerequisites

Before you begin, please read the Contribution page and prepere your environment.

πŸš€ Installation

Get files

git clone https://github.com/aXenDeveloper/vitnode.git && cd vitnode

Install dependencies

pnpm i

Prepere docker containers

pnpm docker:dev

Environment variables for Backend

Go to backend folder and create new .env file:

LOGIN_TOKEN_SECRET=secret

Variables for Database are already set in docker-compose-dev.yml file with inside backend config as default values.

Generate config

Go to root folder and run:

pnpm config:init

Run backend

pnpm backend:dev

Run frontend

pnpm frontend:dev
ℹ️

Frontend should be running on port 3000. If you want to change it go to .env file and fill FRONTEND_URL variable (For example FRONTEND_URL=http://localhost).

πŸ§‘β€πŸ’» PGAdmin

You can use PGAdmin to manage your database. VitNode has this image in Docker Compose. To use it, you need to go to http://localhost:5050 (opens in a new tab) and login with credentials:

  • Email: admin@admin.com
  • Password: admin

Add server

Click on Add New Server button and fill the values:

  • Name: vitnode
  • Host name/address: postgres
  • Database: vitnode
  • Port: 5432
  • Username: root
  • Password: root
Register Postgres in PGAdmin