Skip to content

eirinnm/k-designer

Repository files navigation

K-Designer 🐟

A tool for designing genotyping primers.

Usage

Initial Setup

Requires Node.js

git clone https://github.com/zouden/k-designer.git
cd k-designer
npm install
npm run build

Web interface

  1. Launch the web server by running npm start
  2. Open a browser and connect to localhost:5000.

Development

Get started

After installing dependencies with npm install, start the server in watch mode using Rollup:

npm run dev

Navigate to localhost:5000. You should see the app running. Make a change to src/App.svelte, save it, and the page should automatically reload showing your changes.

If you're using Visual Studio Code we recommend installing the official extension Svelte for VS Code.

Building and running in production mode

To create an optimised version of the app:

npm run build

You can run the newly built app with npm start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

Deploying to the web

With Vercel

Install vercel if you haven't already:

npm install -g vercel

Then, from within your project folder:

cd public
vercel deploy --name my-project

With surge

Install surge if you haven't already:

npm install -g surge

Then, from within your project folder:

surge public my-project.surge.sh