-
Notifications
You must be signed in to change notification settings - Fork 29
Getting Started
Follow the following steps to setup your local development environment.
1. Download and Install NodeJS
A stable version of NodeJS is required on your local development machine. The latest LTS version is recommended. You can use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects.
2. Clone this Repository
Clone this repository to your local machine using git
or your tool of choice.
3. Install Yarn
The modules repository pipelines rely on the Yarn package manager. To install the Yarn package manager through NPM, you can run the following command in the development directory: npm install yarn
4. Install Dependencies
Run yarn install
to install all required node dependencies into the node_modules
folder.
5. Install local copy of frontend
To test modules, a custom version of the frontend is required. Follow the instructions here to set this up.
Once your environment has been setup, refer to the following guides to begin creating your own module:
- Creating a Bundle
- Creating a Tab (TODO)
If you require a custom version of js-slang
follow the instructions here.
- Home
- Overview
- System Implementation
-
Development Guide
- Getting Started
- Repository Structure
-
Creating a New Module
- Creating a Bundle
- Creating a Tab
- Writing Documentation
- Developer Documentation (TODO)
- Build System
- Source Modules
- FAQs
Try out Source Academy here.
Check out the Source Modules generated API documentation here.