Use your preferred IDE

If you want to work locally using your own IDE, you can clone this repo and push changes. Pushed changes will also be reflected in Lovable.

Follow these steps: we use fnm (as system control version manager for Node.js) https://github.com/Schniz/fnm

You need to install Python 3.13 before run our installation scripts, which you can download from here: https://www.python.org/downloads/release/python-3135/. Install the one you need for your OS.

Installation steps:

# Step 1: Install fnm (Fast Node Manager) to manage Node.js versions.
brew install fnm

# Step 2: install and use the node js version with this
fnm use

# Step 3: Install the necessary dependencies.
npm i

# Step 4: Install the necessary dependencies to build our backend.
npm run build:backend:install

# Step 5: Start the development server with auto-reloading and an instant preview.
npm run dev

Edit a file directly in GitHub

• Navigate to the desired file(s).
• Click the "Edit" button (pencil icon) at the top right of the file view.
• Make your changes and commit the changes.

Use GitHub Codespaces

• Navigate to the main page of your repository.
• Click on the "Code" button (green button) near the top right.
• Select the "Codespaces" tab.
• Click on "New codespace" to launch a new Codespace environment.
• Edit files directly within the Codespace and commit and push your changes once you're done.

This project is built with:

• Vite
• TypeScript
• React
• shadcn-ui
• Tailwind CSS
• Fast API

Run our installation script:

• npm run build:backend:install

And then:

• npm run dev

Backend will be running on: http://localhost:8000. Front and Back will start together.

1—Install Poetry dependency manager running the following commands in Terminal:

• MacOS, Linux, WSL, Bash: curl -sSL https://install.python-poetry.org | python3 -

  If you have installed Python through the Microsoft Store, replace "py" with "python" in the command above.

• Export Poetry to your path:

  • Terminal Zsh: echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc && source ~/.zshrc
  • Terminal Bash: echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc && source ~/.bashrc

2—After Poetry installation:

• run: poetry config virtualenvs.in-project true
• then run: cd backend && poetry env activate
• copy, paste and run the command it shows (should start with "source").

3—Install dependencies with:

• poetry install

4—you can run: npm run dev.

Backend will be running on: http://localhost:8000. Front and Back will start together.

APIs: http://localhost:8000/redoc

This part of the backend is made in Rust, so you have to install Cargo following the steps on this URL:

https://doc.rust-lang.org/cargo/getting-started/installation.html

Once done, you can do this:

• cd backend-rust
• cargo run
• WebSocket will be running at: ws://localhost:9001/manuscript

run tests with test coverage: npm run test-backend