/sharickpen

For Codefest III

Primary LanguageJavaScriptMIT LicenseMIT

Logo

Sharickpen

Try out Sharick++ right in your browser; our submission for CodeFest III.

If you do not wish to selfhost this project, you can still try it out using this convenient link We stopped hosting this project, you have to build it yourself

Hello World

Here is a simple "Hello World" program in Sharick++

Console.WriteLine("Hello, World!")

You can read up more on Sharick++ by reading the docs here

Installation

Prerequisites

You can download most of them on their respective websites on Windows and Mac, or use a Package Manager on Linux. You can view instructions to install Sharick++ here

Setup

You can download the project in two ways:

  1. git clone the repository
git clone https://github.com/humboldt123/sharickpen
  1. Alternatively you can download the zip file and unzip it.

Next, open up your terminal of choice and head into the project directory.

cd sharickpen

Dependencies with Node

Install all dependencies for node with npm i:

npm i

Sharick++

Build Sharick++ and locate the Sharick++ executable. This file will most likely be found in Sharick.CLI/bin/Debug/netcoreapp3.1. For windows users it would be called Sharick.CLI.exe or for Linux users, simply Sharick.CLI. Remember the path of this file relative to the index.js.

Config

Open into the config.json file and set sharicklang_path to the aforementioned path. Set sharicklang_debug to true if you want nerd stats displaying with when you do anything. Keep http.port as 80 unless you want it on a different port for some reason.

Set https.enabled to true if you want https and keep the https.port as 443 unless you want it as a different one. Also set https.key_path and https.cert_path. Https is optional and if you are is most likely unnecessary unless you plan to host this project on your own VPS.

Usage

Run with npm run run

npm run run

Linux users may have to use sudo

sudo npm run run

External Libraries

All of the code and art was made for this codefest. That being said, we utilize some external libraries.

  • Scientifica (Pixel art font)
  • Ace (Code Editor used for syntax highlighting)
  • Sharick++; While most of Sharick++ was rewritten, it is still the same language as seen in Codefest α

License

MIT