Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 2.68 KB

README.md

File metadata and controls

54 lines (41 loc) · 2.68 KB


this repo will contain pre-release source files until a stable build is established

The current version of the repository is: PRE-RELEASE

Description

Our mission at codebook.dev is to make coding online easier. We do this by allowing users to code and execute the written code all within their browser window.

Here is a look at how it works:

  1. Your code is sent to a secure server which processes your code.
  2. That code is then executed on the secure server
  3. The output is then sent back to your browser.

Your code or personal information is never stored on the server.

Table of Contents

Usage

  1. Visit the site linked below
  2. Enter your name and follow the account creation steps
  3. Start coding!

Installation

The website is live at https://www.codebook.dev/index.html

Documentation

The documentation can be viewed at https://www.codebook.dev/docs/index.html

Library, Frameworks, and Tools

Netlify allows us to deploy our website in record time and bring our project to you. Netlify also provides us with their authentication protocol to smoothly incorporate user accounts and validation. Their resources can be found here to start building your own websites for free/payed.

For Syntax Highlighting and the In-Window Terminal / Code Editor, we utilized Ace editor. It is a embeddable code editor written in JavaScript that can be found here. A guide on the framework can be found here and the API Reference can be retrieved from the website highlighted earlier.

Judge0 enables our website to securely compact your code, clean it, and compile it. It works closely with our Ace Editor API to provide a smooth coding experience. Their console output is redirected into our client side display where the user can interact with it accordingly.

For the beautiful documentation of the project, we used a public repository by Harnish Design. Fantastic boilerplate for the creation of easy documentation, check it out!