Dictu Playground

A coding playground for Dictu, a high-level dynamically typed, multi-paradigm, interpreted programming language. To know more about the language, vist the Dictu Docs

Developer Documentation

The repository has 2 parts, the frontend and the backend.

Backend

The backend is a node-express server that is run inside Docker containers.

Frontend

The frontend is a react application which uses xterm.js for the web terminal.

Contribution Guidelines 🏗

Are we missing any of your favorite features, which you think you can add to it❓ We invite you to contribute to this project and improve it further

To start contributing, follow the below guidelines:

🌟. Star🌟 the project to bookmark and appreciate the work.

0. Take a look at the existing issues or create your own issues. Wait for the Issue to be assigned to you after which you can start working on it.

1. Fork this repository.

2. Clone your forked copy of the project.

git clone --depth 1 https://github.com/<your_user_name>Dictu-Playground.git

3. Navigate to the project directory 📁 .

cd Dictu-Playground

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/avinashupadhya99/Dictu-Playground.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

git pull upstream master

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perform your desired changes to the code base.

9. Track your changes:heavy_check_mark: .

git add .

10. Check for the changes .

git status

11. Commit your changes .

git commit -m "Relevant message"

12. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

13. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.

14. Add appropriate title and description to your pull request explaining your changes and efforts done.

15. Click on Create Pull Request.

16. Sit back patiently and relax while the project maintainers review your PR. Please understand, at times the time taken to review a PR can vary from a few hours to a few days.

Contributing

Prerequisite - node and npm should be installed globally in your environment.

Fork the repository and clone it in your local environment.
cd frontend and npm install (Do the same with backend)
npm start to start the frontend. (Please refer to frontend for more commands)

umesh-01 / dictu-playground Goto Github PK