Skip to content

kaizjen/nereid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nereid

An Electron-based web browser

v0.0.1 (alpha)

NPM scripts overview

npm start # Starts the electron app
npm run build # Builds the whole project
npm run dev # Builds and runs the app
npm run dev-inspect # Builds and runs the app with --inspect flag
npm run localize # Transpiles YAML locale files into JSON ones
npm run begin # Installes and fixes all dependencies, builds the project. Should be used instead of `npm install`
npm run watch # Starts 3 watch scripts.

Getting started

You will need node and npm (and git) to build Nereid from source.

Automatic install

Run npm run begin. To start Nereid, run npm start.

Manual install

First run npm install. That will install all dependencies.

In svelte, there is a bug which adds empty style tags whenever the animation is done. So, to fix it, run node svlc/hack_empty_svelte_styles.js.

Localization sources (in src/i18n/src/) are in a human-readable but slow YAML format. npm run localize transforms them into JSON

Nereid is written using Typescript and Svelte. To start the app, you need to compile all the sources: npm run build.

Workflow

When you run npm run watch, it will watch for any changes to the sources, and will rebuild your project every time you make a change.

About

An Electron-based web browser

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published