Mirrors/VILLASweb
1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/web/ synced 2025-03-09 00:00:01 +01:00
Code Issues Releases Wiki Activity

revise development and requirements documentation

Browse source
This commit is contained in:
Sonja Happ 2020-07-02 09:11:05 +02:00
parent 02ae930f7c
commit 8ec6248347
2 changed files with 14 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/Requirements.md
View file

@ -1,16 +1,12 @@
# Requirements {#web-requirements}
## Services
- NodeJS: Runs VILLASweb frontend
- Go: Runs VILLASweb backend
- PostgreSQL database (min version 11): Backend database
## Services and tools required for development
- [NodeJS with npm](https://nodejs.org/en/): Runs VILLASweb frontend
- [Go](https://golang.org/): Runs VILLASweb backend
- [PostgreSQL database](https://www.postgresql.org/) (min version 11): Backend database
- [swag](https://github.com/swaggo/swag): For automated API documentation creation
- NGinX: Webserver and reverse proxy for backends (only for production)
- Docker: Container management system
- [Docker](https://www.docker.com/): Container management system
## Installed on your local computer
- NodeJS with npm
- Go (at least version 1.11)
- [swag](https://github.com/swaggo/swag)
- Docker
## Additional requirements for productive use
- [NGinX](https://www.nginx.com/): Webserver and reverse proxy for backends

13
doc/development.md
View file

@ -8,11 +8,11 @@ In order to get started with VILLASweb, you might also want to check our our [de
### Description
The website itself based on the React JavaScript framework.
The website itself based on the [React JavaScript framework](https://reactjs.org/) and the [Flux library](https://facebook.github.io/flux/).
### Required
- NodeJS with npm
- [NodeJS with npm](https://nodejs.org/en/)
### Setup
@ -25,18 +25,19 @@ The website itself based on the React JavaScript framework.
- `npm start`
This runs the development server for the website on your local computer at port 3000.
The backend must be running to make the website work.
The backend must be running to make the website work.
Type `http://localhost:3000/` in the address field of your browser to open the website.
## Backend
### Description
The backend of VILLASweb uses the programming language Go and a PostgreSQL data base.
The backend of VILLASweb uses the programming language Go and a PostgreSQL database.
### Required
- Go (min version 1.11)
- Running PostgreSQL data base (min version 11)
- [Go](https://golang.org/) (min version 1.11)
- [PostgreSQL database](https://www.postgresql.org/) (min version 11)
- [swag](https://github.com/swaggo/swag)
### Setup and Running