Nikodex V2 (front-end)

This repository hold the front-end components for the Nikodex. This project uses Svelte with TailwindCSS.

Dependecies

To setup Nikodex V2 (front-end), you will need:

• NodeJS (>=24)

Setting Up

This project connects to the back-end API on https://github.com/Niko-Dex/nikodex2-backend/, so you want to also clone the repo and configure the API server. After that, create a .env file at the root of the project with the following data:

API_SERVER_URL="<url_of_api_server>" # the backend API server address. in many cases, you shouldn't have to expose the back-end API server, so you can use "http://localhost:8000" or whichever address fastapi give you or you bind using gunicorn
JWT_SECRET="" # the same JWT secret that you setup in the API server
ORIGIN="" # you may need to specify the address that Vite provide here if you are not able to access this page. otherwise, leave this BLANK
WEBHOOK_URL="" # this is for the "Submit a Niko" page. this page uses Discord Webhook to receive data. you may need to create a new server, or make a new channel in your existing server to create a new webhook

Developing

To start developing for the Nikodex front-end, install dependencies with npm install (or pnpm install or yarn), then start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of Nikodex:

npm run build

You can preview the production build with npm run preview. To run the production build of Nikodex, run

node --env-file=.env build

rainwater is cute kbity