Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avinashupadhya99/dictu-playground
https://github.com/avinashupadhya99/dictu-playground
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/avinashupadhya99/dictu-playground
- Owner: avinashupadhya99
- License: mit
- Created: 2021-01-25T07:59:05.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-03T13:41:15.000Z (over 3 years ago)
- Last Synced: 2023-03-04T17:37:48.743Z (almost 2 years ago)
- Language: JavaScript
- Size: 587 KB
- Stars: 6
- Watchers: 2
- Forks: 22
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Dictu Playground
A coding playground for [Dictu](https://github.com/dictu-lang/Dictu), a high-level dynamically typed, multi-paradigm, interpreted programming language. To know more about the language, vist the [Dictu Docs](https://dictu-lang.com/)
## Developer Documentation
The repository has 2 parts, the [frontend](https://github.com/avinashupadhya99/Dictu-Playground/tree/develop/frontend) and the [backend](https://github.com/avinashupadhya99/Dictu-Playground/tree/develop/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](https://github.com/avinashupadhya99/Dictu-Playground/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](https://github.com/avinashupadhya99/Dictu-Playground/) repository.
**2.** Clone your forked copy of the project.
```
git clone --depth 1 https://github.com/Dictu-Playground.git
```
**3.** Navigate to the project directory :file_folder: .
```
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
```
**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
```
**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](https://github.com/avinashupadhya99/Dictu-Playground/tree/develop/frontend) for more commands)
### Contributors
## License
MIT License