Skip to content

Latest commit

 

History

History
74 lines (57 loc) · 2.59 KB

setup_backend.md

File metadata and controls

74 lines (57 loc) · 2.59 KB

← back

Back-end Server Setup



Server "skeleton"

For installing the backend skeleton we will need a copy of the repository, found in this link, installed locally. For this purpose we should run the following lines:

$ git clone https://github.com/Zendro-dev/graphql-server.git backend-skeleton
$ cd backend-skeleton
$ npm install

From now on, in this document, we will assume that your backend-skeleton is installed in /your-path/backend-skeleton.



Install backend code generator

For installing the backend generator we will need a copy of the repository, found in this link, installed. For this purpose we should run the following lines:

$ git clone https://github.com/Zendro-dev/graphql-server-model-codegen.git backend-generator
$ cd backend-generator
$ npm install -g

If you only want to install it locally, then you should run $ npm install instead and then adapt each command accordingly.



Generate the code

After installing the backend-generator and if we have our data models defined, then we can generate the code for the graphql server. For this purpose we should run the following lines:

$ code-generator -f <input-json-files> -o <output-directory>

INPUT:
<input-json-files> - directory where json models are stored, indicated by the flag -f
<output-directory> - directory where the generated code will be written, indicated by the flag -o

Example:

$ code-generator -f /your-path/json-files -o /your-path/backend-skeleton



Run GraphQL server

$ cd /your-path/backend-skeleton
$ migrateDbAndStartServer.sh

The command migrateDbAndStartServer.sh will use the appropriate database credentials in config/data_models_storage_config.json to create the tables specified in the migrations folder.



Setup environment variables

You can also specify some environment variables:

  • PORT - The port where the app is listening, default value is 3000
  • ALLOW_ORIGIN - In development mode we need to specify the header Access-Control-Allow-Origin so the SPA application can communicate with the server, default value is http://localhost:8080.
  • LIMIT_RECORDS - Maximum number of records that each request can return, default value is 10000.
  • MAX_TIME_OUT - Maximum number of milliseconds that a zendro server will wait to connect with another zendro server.

Example:

$ PORT = 7000 && node server.js

Now your server will be listening on PORT 7000.