Skip to content

CodeChillAlluna/code-chill-outdated

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

code-chill

Travis branch License: GPL v3 Maintainability Codacy Badge Coverage Status

Master project : Online development environment

Summary

  • If you want to install our latest release click here
  • If you want to set up our project from scratch using our vagrant click here
  • If you want to set up our project without vagrant click here

Release installation guide

You can run our releases in our vagrant or install it on your own machine. You can download our releases here

Install on Vagrant

  1. Extract the release in your vagrant folder.
  2. Follow Vagrant installation guide
  3. Launch Server
  4. Launch Client

Install on your machine

  1. Extract the release on your machine.
  2. Install all the dependancies (Check install/install.sh to have all dependancies).
  3. Launch Server
  4. Launch Client

Vagrant installation guide

Environment installation

Requirements

Download

Choose either of the solutions:

  • Cloning the repository : git clone https://github.com/CodeChillAlluna/code-chill.git
  • Downloading the repository : https://github.com/CodeChillAlluna/code-chill/archive/master.zip

Setup vagrant

  1. Move to the project directory : cd code-chill
  2. Run the command : vagrant up.
  3. Wait for Vagrant to download all dependencies.
  4. Run vagrant ssh to connect to the virtual machine.
  5. You should be connected to the VM, in /vagrant where the project is located.

Common 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
  • Verify packages are up to date: vagrant provision

Vagrantless installation guide

Environment installation

Requirements

You will find all our project dependancies in install/install.sh

Download

Choose either of the solutions:

  • Cloning the repository : git clone https://github.com/CodeChillAlluna/code-chill.git
  • Downloading the repository : https://github.com/CodeChillAlluna/code-chill/archive/master.zip
  • Downloading our release : https://github.com/CodeChillAlluna/code-chill/releases

Usage

Spring

Production Mode

To build Spring, you will have to use the following command lines :

  1. cd src/spring : will place you in the source dictionnary.
  2. sh mvnw clean package : will compile java files to create a runnable jar package.
  3. cd target : will place you in the build dictionnary of the project.
  4. java -jar spring-0.0.1-SNAPSHOT.jar : will launch the Spring project, depending on what you are using the version might not always be "0.0.1".
  5. Server API accessible at http://localhost:8080/

Development Mode

To run Spring in development mode, you will have to use the following command lines :

  1. cd src/spring : will place you in the source dictionnary.
  2. sh mvnw spring-boot:run: will compile the source code and launch the spring server
  3. Server API accessible at http://localhost:8080/

React

Production Mode

To build React, you will have to use the following command lines :

  1. cd src/client : will place you in the source dictionnary.
  2. sudo yarn install : will install if they are missing and update the dependencies of the project.
  3. yarn build : will build the project.
  4. serve -s build : will launch the project properly.
  5. Website accessible at http://localhost:5000/

Development Mode

To run react in development mode, you will have to use the following command lines :

  1. cd src/client : will place you in the source dictionnary.
  2. sudo yarn install : will install if they are missing and update the dependencies of the project.
  3. yarn start: will check your code validity and launch the node server.
  4. Website accessible at http://localhost:3000/