Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.76 KB

README.md

File metadata and controls

36 lines (27 loc) · 1.76 KB

Definity Website

Introduction

This repository hosts the Definity website. It's made entirely in TypeScript/JavaScript using Express and EJS, to make hosting it yourself easier.

By default, it runs on port 80 (as is standard), but you can modify it on the first line of index.ts / index.js. These values are ignored in production. Please make sure ports 80 and 443 are available.

Running

Open a terminal, and setup if you haven't done git clone yet:

$ > git clone https://github.com/DefinityTeam/website
$ > cd website
$ > npm ci --only=production

Starting in development: npm run start
Starting in production: npm run start -- --prod

Building

$ > npm ci
$ > npm run build

(Yes, it's that easy.)

Contributing

When contributing to the main/parent repository, it is recommended to use npm run watch. When you make changes to the directory, or any .ts/.json file, nodemon will automatically restart the server.

Once you've finished your changes, ^C and npm run build. After that, you're good to go.

License

Copyright (C) 2021 Definity

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.