Each Platforms for Developer 

Installation 

We introduce how to install optinist for developer. We have developed optinist python(backend) and typescript(frontend), so you need to make both environment. Please follow instructions below.

1. Make backend environment 

Install Tools 

Unix-like platforms
- Linux
  - Install Tools
- Windows WSL
  - Install Tools
- Mac
  - Install Tools
Windows
- Install Tools

Install Node.js 

Get node with version 20

Node.js Official

You can also install node via nvm

After install node, install yarn.

npm install -g yarn

Clone repository 

git clone https://github.com/oist/optinist.git
cd ./optinist

Create anaconda environment 

conda create -n optinist_dev python=3.8 poetry
conda activate optinist_dev

conda config --set channel_priority strict

Install requirements 

poetry install --no-root --with dev

If you will make PRs, please see the FOR DEVELOPERS section.

Set saving directory 

Optinist default saving directory is /tmp/studio. If you reboot your PC, this repogitory content is deleted. And setting the saving directory in environment path.

export OPTINIST_DIR="your_saving_dir"

2. Run backend 

python main.py

python main.py log is as blow:

$ run_optinist
INFO:     Will watch for changes in these directories: ['/home/oist/optinist/backend']
INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [6520] using statreload
INFO:     Started server process [6557]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

If you won’t develop the frontend code, launch browser and go to http://localhost:8000

3. Run frontend 

Open new terminal window, and go to frontend directory.

# from optinist root directory
cd frontend

Then install packages and run.

yarn install
yarn start

Launch browser, and go to http://localhost:3000

Note

frontend in development environment uses port 3000, while production optinist uses 8000.

It opens correctly!

Done!