Thank you for your interest in Simulai!
Simulai is written with the following frameworks and tools:
We strongly encourage contributors to be familiarized with these tools.
Before you can start helping with Simulai, you will want to install and configure the following dependencies on your machine:
To contribute code to Simulai, you need to fork the repository.
To build Simulai, you clone your fork of the repository:
-
Clone your GitHub forked repository:
git clone https://github.com/<github_username>/simulai.git
-
Go to the Simulai directory:
cd simulai
Install npm dependencies:
```sh
npm i
```
-
Start development server
npm run dev
-
To access the local server, enter the following URL into your web browser:
http://localhost:5173/
- Run tests
First, familiarize yourself with the libraries we are using for tests.
Simulai uses Vitest for unit and component tests, as well as Playwright for e2e tests.
After cloning the repository to your local environment and running npm i, you can run tests with the following:
npm run test:unit
npm run test:e2eThe same tests will run for any PR requested to the main branch, and all tests should pass before any PR is merged.
- Write tests
All new features should be accompanied by at least one test for the new feature.
All bug fixes should be accompanied by a test that replicates the bug.
When writing a test, check that it fails correctly before checking that it passes.
After you've made the improvements, you can open a pull request and a member of the Simulai team (well either SK or Alfred for now!) will work with you on the PR!