Skip to content

JefferMarcelino/sml-frontend

Repository files navigation

Logo

SamoraLang Playground

The frontend for the online playground for Samora-lang
Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributors
  4. License
  5. Support

About The Project

Welcome to the SamoraLang Playground—an innovative online platform designed for direct SamoraLang testing right in your browser. This repository contains the frontend codebase for the complete application.

(back to top)

Tech stack

React Official Website TypeScript official Website

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Before you begin, ensure that you have Node.js and npm (Node Package Manager) installed:

  • node: Visit the oficial website to download and follow the installation instructions.
  • npm: Open your terminal and run the following command to ensure you have the latest version of npm installed.
    npm install npm@latest -g

Contributing

We welcome contributions to enhance the SamoraLang Playground project. To contribute, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine:
    git clone https://github.com/YourUsername/sml-frontend.git
    cd sml-frontend
  3. Create a new branch for your feature or bug fix:
    git checkout -b feat/your-feature-name
  4. Make your changes and commit them using Conventional Commits:
    git commit -m "feat: add new feature"
  5. Push your changes to your forked repository:
    git push origin feat/your-feature-name
  6. Create a pull request on the original repository, comparing your branch with the develop branch. The pull request must adhere to our Pull Request Template, where you will provide a detailed description of the changes made, the problem solved, and any additional context.

By following these guidelines, you help ensure a smooth and collaborative development process.

(back to top)

Contributors

Without your contributions, this project wouldn't have been possible. Thank you so much for your time, effort, and dedication! 😄

(back to top)

License

SamoraLang is licensed under the terms of the MIT License. check out LICENSE for details.

(back to top)

Support

We would love to have you, feel free to open issues and pull requests, and Don't forget to leave a star⭐