Skip to content

Commit 9db3302

Browse files
DOC: add different building/installation patterns
1 parent ee097fc commit 9db3302

1 file changed

Lines changed: 44 additions & 13 deletions

File tree

README.md

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,20 @@
77
[![Coverage Status](https://coveralls.io/repos/github/CodeChillAlluna/code-chill/badge.svg?branch=master)](https://coveralls.io/github/CodeChillAlluna/code-chill?branch=master)
88

99
Master project : Online development environment
10+
# Summary
11+
* If you want to install our latest release click [here](#release-installation-guide)
12+
* If you want to set up our project from scratch using our vagrant click [here](#vagrant-installation-guide)
13+
* If you want to set up our project without vagrant click [here](#vagrantless-installation-guide)
14+
# Release installation guide
15+
* You need <a href="http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html">Java 8+</a> and <a href="https://nodejs.org/en/">NodeJS 9+</a>.
16+
* You can install Code&Chill <a href="https://github.com/CodeChillAlluna/code-chill/releases">here</a>.
17+
* Go to your spring repository : `cd ./spring`
18+
* Run the command : `java -jar spring-0.1.0.jar`
19+
* And then : `npm install serve`
20+
* To run the server : `serve -s client`
21+
* You can go to <a href="http://localhost:5000/">http://localhost:5000/</a> on your browser to access to your terminal.
1022

11-
# Installation guide
23+
# Vagrant installation guide
1224
## Environment installation
1325
### Requirements
1426
* **Vagrant** is needed, you can download it here :
@@ -32,19 +44,38 @@ Choose either of the solutions:
3244
- Reload the VM: `vagrant reload`
3345
- Delete the VM: `vagrant destroy`
3446
- Verify packages are up to date: `vagrant provision`
47+
# Vagrantless installation guide
48+
## Environment installation
49+
### Requirements
50+
You will find all our project dependancies in `install/install.sh``
51+
### Download
52+
Choose either of the solutions:
53+
- Cloning the repository : `git clone https://github.com/CodeChillAlluna/code-chill.git`
54+
- Downloading the repository : `https://github.com/CodeChillAlluna/code-chill/archive/master.zip`
3555

36-
## Usage
37-
## Usage
56+
# Usage
57+
## Spring
3858
### Build Spring
39-
To build Spring , you will have to use the following command lines :
59+
To build Spring, you will have to use the following command lines :
60+
61+
1. `cd src/spring` : will place you in the source dictionnary.
62+
2. `sh mvnw clean package` : will compile java files to create a runnable jar package.
63+
3. `cd target` : will place you in the build dictionnary of the project.
64+
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".
65+
### Run Spring
66+
To run Spring in development mode, you will have to use the following command lines :
67+
1. `cd src/spring` : will place you in the source dictionnary.
68+
2. `sh mvnw spring-boot:run`: will compile the source code and launch the spring server
4069

41-
1. cd src/spring : will place you in the source dictionnary.
42-
2. sh mvnw clean package : will compile java files to create a runnable jar package.
43-
3. cd target : will place you in the build dictionnary of the project.
44-
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".
70+
## React
4571
### Build React
46-
To build React , you will have to use the following command lines :
47-
1. cd src/client : will place you in the source dictionnary.
48-
2. sudo yarn install : will install if they are missing and update the dependencies of the project.
49-
2. yarn build : will build the project.
50-
3. serve -s build : will launch the project properly.
72+
To build React, you will have to use the following command lines :
73+
1. `cd src/client` : will place you in the source dictionnary.
74+
2. `sudo yarn install` : will install if they are missing and update the dependencies of the project.
75+
3. `yarn build` : will build the project.
76+
4. `serve -s build` : will launch the project properly.
77+
### Run React
78+
To run react in development mode, you will have to use the following command lines :
79+
1. `cd src/client` : will place you in the source dictionnary.
80+
2. `sudo yarn install` : will install if they are missing and update the dependencies of the project.
81+
3. `yarn start`: will check your code validity and launch the node server.

0 commit comments

Comments
 (0)