Skip to content

waasiq/yakamoz

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

yakamoz



Yakamoz

Table of Contents

  1. About The Project
  2. Getting Started
  3. License
  4. Documentation
  5. Future Plans

About The Project

Yakamoz is an small scale interpreted language that was mainly built in older to help Turkish speakers learn programming on a relative easier scale.

Motivation

The motivation behind building yakamoz was to teach my roomate programming and also learn how interpreted languages work behind the scene. It may also be used to teach children about programming in Turkish schools. Yakamoz is in it's early stage so there are still a lot of things to implement and a lot of errors to correct. Due to my full time studies I can't dedicate a lot of time to it's development, please feel free to contact me or fork this project for help.

Built With

Source code for Yakamoz is solely built with Python:

  • Python
  • Online compiler is built with:

  • Flask
  • React JS
  • Getting Started

    Prerequisites

  • Python
  • Flask
  • React JS
  • Installation

    For running offline version of compiler:

    1. Clone the repo
      git clone https://github.com/waasiq/yakamoz.git
    2. Run the shell.py file inside the ./src folder.
      python ./src/shell.py
      
    3. Use the run command inside to read from a file or write the code.
       yakamoz >>> run('app.ykmz')
      

    For running online version of compiler:

    1. Clone the repo
        git clone https://github.com/waasiq/yakamoz.git
    2. Install the python dependencies using pip in web/backend.
        pip install -r requirements.txt
      
    3. Install the npm dependencies using npm in web/frontend.
        npm install 
      
    4. Run both the backend and frontend and do change the API link in package.json as well as Output Component to https://127.0.0.1:5000/api/code

    License

    MIT License
    Distributed under the MIT License. See LICENSE for more information.

    Documentation

    Documentation can be found on the website. Click on Docs to access Documentation there.

    Future Plans

    • Improve the documentation and improve the compiler.