Code & Chill

Master project : Online development environment

Code&Chill is a web application written in Java and React. It gives users the possibility to use their development environment in a browser. No more worries about setup so just code, and chill.

If you want to know more about this project check our website.

This repository contains the server part of the project, if you want to check the client part click here.

Summary

• Installation for contributing to this project
• Installation of the application

Development Environment

Here is the setup to installing the development environment if you want to contributing to this project.

Requirements

• Virtualbox, or other virtualization tools
• Vagrant

Clone repo and create branch

First you need to clone the repo. The master branch is protected, so you need to create a branch to start developing.

git clone https://github.com/CodeChillAlluna/code-chill-server.git
cd code-chill-server
git checkout -b your_branch

Setup vagrant

Then you need to start the vagrant to create the VM.

vagrant up

Common vagrant commands

• Connect to the VM: vagrant ssh
• Shutdown the VM: vagrant halt
• Launch the VM: vagrant up
• Reload the VM: vagrant reload
• Delete the VM: vagrant destroy
• Provisioning the VM: vagrant provision

Start application

To start or building the application or execute tests, you need to access the VM via SSH.

vagrant ssh

Start the API

mvn spring-boot:run

# You can also use our custom script to clean docker container before start
./server run

Then you can request : http://localhost:8080 to view use the API.

Execute tests

mvn test

# You can also use our custom script to clean docker container before start
./server test

Build the application

mvn clean package

# You can also use our custom script to clean docker container before start
./server package

Format your code

mvn fmt:format

Remember to format your code before commit, otherwise your build will fail.

API Documentation

If you want to see the doc for this API, go to http://localhost:8080/swagger-ui.html

Installation

The procedure to install Code&Chill is accessible in our main repository.