CaseVault

Main branch of the repository containing CaseVault: a content repository for case-based learning. For more information, please review the Organization README document, for more context and details concerning the EthicApp project.

• CaseVault
  • 1. Contributing
  • 2. Required skills
  • 3. Installation
    • 3.1 With Docker installed
    • 3.2 Run locally without Docker

1. Contributing

Please head to the CONTRIBUTING document and review our communication channels for the project. We strongly recommend to have Docker installed in your machine, as it will be used to run the project.

2. Required skills

In order to work in the project you should be familiar with the following:

• React
• Vite
• Material-UI
• Ruby on Rails

Knowledge of Docker could be helpful, but not required.

3. Installation

3.1 With Docker installed

If you have Docker installed, you can run the project on the root folder the following commands:

docker-compose build
docker-compose up

3.2 Run locally without Docker

Go to the frontend folder and run the following commands:

npm install
npm run dev

Then, go to the backend folder and run the following commands:

bundle install
rails db:create
rails db:migrate
rails s