Browse Source

Added readme and mit license

rigwild 1 year ago
parent
commit
90a7f736ab
2 changed files with 66 additions and 7 deletions
  1. 21 0
      LICENSE
  2. 45 7
      README.md

+ 21 - 0
LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Prise3D
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

+ 45 - 7
README.md

@@ -2,23 +2,61 @@
 
 Travaux développés par Antoine dans le cadre de son stage de DUT2.
 
+## Run as a Docker instance
+### Run the server + client version
+```sh
+# TODO
+# docker-compose -f docker-compose.yml up backapp
+```
+
+### Run the client only version
+```sh
+# TODO
+#docker-compose -f docker-compose.yml up backapp
+```
 
-## Project setup
+
+## Run on the file system
+### Project setup
+Install project's dependencies.
 ```
 yarn install
 ```
 
-### Compiles and hot-reloads for development
+### API
+#### Run the server
+```sh
+yarn run api:start
 ```
-yarn run serve
+
+#### Run the server with hot-reload for development
+```sh
+yarn run api:dev
 ```
 
-### Compiles and minifies for production
+#### Automatically fix the API code syntax with ESLint
+```sh
+yarn run api:lint
 ```
-yarn run build
+
+
+### Client
+#### Compile and minify for production
+Files will be built to the `dist/` directory.
+```sh
+yarn run app:build
 ```
 
-### Lints and fixes files
+#### Run a hot-reload server for client development
+```sh
+yarn run app:dev
 ```
-yarn run lint
+
+
+#### Automatically fix the client code syntax with ESLint
 ```
+yarn run app:lint
+```
+
+## License
+[The MIT license](LICENSE)