Nantral Platform

• Nantral Platform Website: nantral-platform.fr
• Documentation: docs.nantral-platform.fr

Get started

• Requirements: python3, pipenv (be sure its in your PATH!), and node
• Setup everything the first time:

  make install

• Update your local codebase with last changes:

  git pull
  make update

• Start the back end server:

  cd backend && pipenv run start

• Start the front end server (in another terminal):

  cd frontend && npm run start

Create a local account

• Access the login page on http://localhost:8000 and create your account.
• Access the administration panel at http://localhost:8000/admin with the default login admin/admin and grant yourself admin rights (tick the 3 checkboxes).
• Log out from the administration panel, go back to the website and log in with your personal account.

Warning: the admin account is not usable for the website (only for the administration panel), you have to create a local account to use the website.

Debugging: if you can't connect to the admin account, change its password with pipenv run django changepassword admin

Contribute

• Create a [TICKET] issue to describe what you want to do. Assign yourself to the issue if you want to work on it.
• Create a new branch linked to the issue and then create a Pull Request.
• Test your code:
  • All-in-one command:

    make test

  • in the backend:

    pipenv run lint  # use lint:fix to fix errors
    pipenv run test

  • in the frontend:

    npm run types
    npm run lint  # use lint:fix to fix errors
    npm run jest  # use jest:u to update snapshots

    Run these 3 commands at once: npm run test

Contributors

Thank you for your contribution!