Skip to content

Latest commit

 

History

History
81 lines (49 loc) · 3.58 KB

README.md

File metadata and controls

81 lines (49 loc) · 3.58 KB
Raw

Stratego Site

CircleCI Codacy Badge

This project is licensed under the MIT License

Motivation

This repository contains the source code for the Stratego presentation and documentation site.

We are compromised with the transparency of the software and we want to let you know what is exactly being executed in your browser at the time you access to this application.

Contributions

If you want to make a contribution, let us know by adding a new issue to this repository.

There are no many reasons to add things to this repository in particular, specially if you are not directly responsible of the content on it, but we are aware that this is great way to communicate ideas and/or report application errors.

⚠️ If you want to report a security vulnerability, please send us an email or create a security advisory in the GitHub Security tab.

Do NOT create issues for security vulnerabilities reports.

Getting Started

Prerequisites

First of all, you will need to have the PNPM package manager installed.

If you don't have PNPM installed, you can try one of the official installation methods according to your system.

Alternatively, we highly recommend the use of the Volta tool manager to install PNPM.

If you don't have Volta installed, just follow the official Volta installation instructions.

Then, once Volta is installed, you can install PNPM by running:

volta install pnpm

You can optionally activate the Volta experimental PNPM support

Installing the project dependencies

Just execute:

pnpm install

Running the development server

Some features use external services which require authentication, to ensure the app is fully working, you will also need to set up the environment variables. To do this, just copy the .env.example file to .env.local and fill the variables with the correct values.

To start the development server just run:

# To start a local server without TLS encryption:
pnpm dev # Some features are not available in this mode

# To start a local server with TLS encryption:
pnpm cert # only once. This will generate the self-signed TLS certificate
pnpm dev:ssl

Note this application use a custom server to handle the TLS encryption. This is because Next.js does not support TLS encryption out of the box.

The application will be started in localhost:3000. Depending on your development server start command, the app will be accessible under the HTTP or HTTPS protocol.

Development technologies

This project use strictly TypeScript and SASS, powered by the Next.js framework.

For further information about the development technologies used in this project, please refer to the package.json