Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Lionel Laské committed Feb 15, 2023
1 parent 5753cb1 commit 140f95a
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [1.5.0] - 2023-02-15
### Added
- Assignments feature: API and Dashboard
- Code coverage
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,17 @@ Sugarizer Server allows the deployment of Sugarizer on a local server, for examp

## Running Sugarizer Server

The easiest way to run Sugarizer is to use Docker. To do that, type command lines:
The easiest way to run Sugarizer Server is to use Docker. To do that, type command lines:

git clone https://github.com/llaske/sugarizer
git clone https://github.com/llaske/sugarizer-server
cd sugarizer-server
sh generate-docker-compose.sh
docker-compose up -d

For other options to install Sugarizer on your computer, on the cloud or on a RaspberryPI, see [here](docs/install.md).
For other options to install Sugarizer Server on your computer, on the cloud or on a RaspberryPI, see [here](docs/install.md).

If you want to upgrade from a previous Sugarizer Server version, please have a look on the [Migration guide](docs/migrate.md).


## Global architecture
Expand All @@ -27,7 +29,7 @@ See [here](docs/architecture.md) for a global description of the Sugarizer Serve

## Server settings

Sugarizer settings are loaded by default from file [env/sugarizer.ini](env/sugarizer.ini). You could change the name of this file by changing the value of environment variable ``NODE_ENV``. So if the ``NODE_ENV`` variable is set to ``production``, Sugarizer will try to load ``env/production.ini`` file.
Sugarizer Server settings are loaded by default from file [env/sugarizer.ini](env/sugarizer.ini). You could change the name of this file by changing the value of environment variable ``NODE_ENV``. So if the ``NODE_ENV`` variable is set to ``production``, Sugarizer Server will try to load ``env/production.ini`` file.

Following is the typical content of Sugarizer Server settings file:

Expand Down Expand Up @@ -136,7 +138,7 @@ Once the admin account is created, you could access Sugarizer Dashboard on http:

## Server API

To implement the above functionalities, the sugarizer backend exposes an API. The API routes look as follows:
To implement the above functionalities, the Sugarizer backend exposes an API. The API routes look as follows:


#### INFORMATION ROUTE
Expand Down Expand Up @@ -307,7 +309,7 @@ Note that settings for unit testing are defined in [env/test.ini](env/test.ini).

# Optimize performance

If you want to optimize JavaScript performance, you could generate an optimized version of Sugarizer and Sugarizer-Server with [Grunt](http://gruntjs.com). This optimized version will minimize and reduce the size of the public resources.
If you want to optimize JavaScript performance, you could generate an optimized version of Sugarizer and Sugarizer Server with [Grunt](http://gruntjs.com). This optimized version will minimize and reduce the size of the public resources.

First, ensure that Node.js and npm are installed on your machine. See [here](http://nodejs.org/) for more information.

Expand All @@ -323,11 +325,11 @@ Then launch Grunt task to minify Sugarizer JavaScript files:

grunt -v

Now navigate to Sugarizer-Server directory and install the specific component for Sugarizer-Server by running:
Now navigate to Sugarizer-Server directory and install the specific component for Sugarizer Server by running:

npm install

Then launch Grunt task to minify Sugarizer-Server CSS, Image and JavaScript files:
Then launch Grunt task to minify Sugarizer Server CSS, Image and JavaScript files:

grunt -v

Expand Down
2 changes: 1 addition & 1 deletion docs/migrate.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Migration process
# Migration guide

This documentation describes migration process to a recent Sugarizer Server version.

Expand Down

0 comments on commit 140f95a

Please sign in to comment.