diff --git a/README.md b/README.md index 85f6d4603..027ae6239 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ -# AAWeb +# Superalgos Web Server -The main function of AAWeb is to serve the js files needed at the browser to run the Canvas App. +The main function of this Web Server is to serve the js files needed at the browser to run the Canvas App. ## Current Status -AAWeb is under heavy development, evolving from a prototype to a working MVP. It currently does many more things than expected and we are in the process of tearing it apart and replace some of its functionality with Master App modules. +Web Server is under development, evolving from a prototype to a working MVP to an alpha stage module. ## Installation -Clone this repo and get from the Core Team the .ENV file and config file for this to run. Then: +This repo is included at the Superalgos Desktop App and you can play with it once you install the full Desktop App via downloading the latest release, which currently runs on code. + +In case you want to individually play specifically with this module, clone it and then: ``` npm install @@ -25,6 +27,8 @@ At the configuration file, you must verify that this is pointing to the place wh "pathToFilesComponent": "../Files-Component/src" ``` +It is highly recommended that you download and unzip the Desktop App release which includes everything you need to set up your local environment in a few clicks. + ## Execution There is a Visual Studio solution already setup for quick debugging. Otherwise, you could do: @@ -35,5 +39,7 @@ node.exe server.js ## Usage -Running AAWeb will create a Noode.js server at port 1337. Navigate with your browser there and the Canvas App should show up. +Running the Web Server will create a Noode.js server at port 1337. Navigate with your browser there and the Canvas App should show up. + +For more information, continue reading here: https://github.com/Superalgos/DesktopApp/blob/master/README.md