Code Capsule App

This repository hosts the code for a Graasp app that lets users write code reviews, edit and annotate code, alone or in collaboration.

Installation

Running the app

Create a .env.development file with the following content:

VITE_PORT=3005
VITE_API_HOST=http://localhost:3000
VITE_MOCK_API=true
VITE_GRAASP_APP_KEY=45678-677889
VITE_VERSION=latest
# VITE_ENABLE_VERBOSE_MESSAGES=true # comment this out if you want to enable verbose messages

Launch the app with yarn dev.

Running the tests (automatic run on commit with husky)

Create a .env.test file with the following content:

VITE_PORT=3333
VITE_API_HOST=http://localhost:3000
VITE_MOCK_API=true
VITE_GRAASP_APP_KEY=45678-677889
VITE_VERSION=latest
# VITE_ENABLE_VERBOSE_MESSAGES=true # verbose messages will be shown when this is set

# dont open browser
BROWSER=none

Start the tests with yarn test for automatic start of the dev server as well as cypress (similar to the CI run). Or open 2 terminals and execute yarn dev in one and yarn cypress:open in the other. This will open the Cypress GUI app in which you can run individual tests and interact with the app in it's testing environnement.

Documentation

How to bootstrap your app and set every tool you need

Please have a look at the documentation to start your app and setup all necessary tools.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Basile Spaenlehauer 💻 🤔 🔬 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!