freljord

Personal site powered by Ryze

---

Quick start

Get ready

• First and foremost, Ryze should be running in local

• Packages are installed with either npm or yarn

$ npm install

or

$ yarn

Start development

• Start a Node.js server with Webpack Middleware

$ yarn run start

Run production build

• Build & bundle everything in the /dist/ directory & start server

$ make prod

• If you don't have make utilities installed

$ yarn run build && yarn run prod

Deployment

1. Build an image of docker

$ make

2. Push image to remote docker image registry

// TODO: Create a repository

3. Deploy with K8s

// TODO: with Docker & Kubernetes

Docs

• conventions contains code conventions you need to know before developing

• roadmap is a brief plan of the entire project

• devlog records developing progress

• traps might offer you some advice which helps avoid annoying things while developing

• todos

Contributing

Code of Conduct

Contributing Guide

• // TODO

Licenses

• This project is under the MIT license. See LICENSE