zendro-dev / zendrostarterpack Goto Github PK

Since MacOS Monterey there is a feature called "Airplay receiver" that uses the port 7000.
We need to change giql's port.

Define and publish the first stable version

This issue affects at least five sub-projects. The skeleton projects, the code-generators, and this Starter-Pack.

Merge all feature branches into master

In the affected projects merge all feature branches, that belong into stable, into master.

Tag the respective versions

Then, tag this version as 0.1.0 and latest-stable. The latter is somewhat questionable according to semantic versioning.

git tag -fa '0.1.0' -m 'Current stable and first alpha version. Yeah!'
git tag -fa 'latest-stable' -m 'Current stable and first alpha version. Yeah!'

Adjust usage to latest-stable

Especially in the Sandbox adjust the git clone commands to the above latest-stable tag. Use latest-stable instead of 0.1.0 to implement inherent usage of the latest stable version in the future when possibly new versions are tagged as latest stable.

Check other projects

Check the skeleton and code generator projects, especially the integration tests. Maybe the adjustment to using "latest stable" needs to be done there, too. If so, implement it, please.

Create a new branch of the StarterPack called exactly as the React.js branches in the projects

• single-page-app-codegen and
• single-page-app

are called.

Within this new branch adjust the docker-compose files:

• docker-compose-dev.yml
• docker-compose.yml

So they work with the new React interface. Update the Readme also!

This should prepare the soon to be made merge into master.

Expected work time: 2h

The user, role and role_to_users models definitions are not needed anymore by graphql-server and spa code-generators, now are generated without these model definitions. This models definitions can be removed from StarterPack setup.

Tasks:

• Remove user, role and role_to_user models definitions from StarterPack setup.
• Add some example models definitions to the StarterPack setup (e.g. person, dog, ...).

ScienceDbStarterPack is out of date. The master branch needs to be updated to have latest Dockerfiles and up-to-date documentation.

Use the Dockerfiles and project structure of the branch BreedPatH-DB to bring master up to date.

Make one crucial difference to BreedPatH-DB in using git submodules to manage the single-page-application and graphql-server sub-projects in the Starter-Pack. This gives us the opportunity to easily update an existing installation of ScienceDB to latest changes in the master branches of the above two projects.

Expected work time: 4h

To access the seeder for default-sql, we need first create a folder for that.

Hi there,

Thanks for this awesome project :)

Just a few things that I've found using https://github.com/Zendro-dev/ZendroStarterPack

• Useful but not too dramatic that repo https://github.com/Zendro-dev/graphql-server had an .env in its root.

• Remove .gitkeep in https://github.com/Zendro-dev/ZendroStarterPack/tree/master/data_model_definitions as this produces errors when executing graphql-server-model-codegen

• Change number 3 in https://github.com/Zendro-dev/Zendro-dev.github.io/blob/master/setup_data_scheme.md as for Data Model Definition for table B we need a many to many relation:

Data Model Definition for table B:

{
    "model": "department",
    "storageType": "mongodb",
    "attributes": {
        "department_id": "String",
        "department_name": "String",
        "employee_ids": "[String]"
    },
    "associations": {
        "employees": {
            "type": "many_to_many", ####change one_to_many to many_to_many
            "implementation": "foreignkeys",
            "reverseAssociation": "departments",
            "target": "employee",
            "targetKey": "department_ids",
            "sourceKey": "employee_ids",
            "keysIn": "department",
            "targetStorageType": "mongodb"
        }
    },
    "internalId": "department_id",
    "id": {
        "name": "department_id",
        "type": "String"
    },
    "useDataLoader": false
}

Update

Make the StarterPack use the latest-stable tags of all integrated sub-projects.

Move away from git submodules

Instead of using git submodules, write a simple setup.sh script that uses either wget or curl to fetch the latest-stable of the respective submodules, which are the skeleton projects.

Adjust naming

If not too much work, replace all occurrences of sciencedb and sdb with zendro.

Adjust the docker-compose files

In the docker-compose files the following containers should exist:

• postgres database
• graphql-server
• single-page-app (in production this is an nginx instance serving the compiled and now static SPA)
• graphiql-auth

Several issues have to be taken care of.

• Make sure the files work. There is a bug in the single-page-application with Docker and React scripts. Fix that.
• Remove all occurrences of ports:, because this is a security loophole. But leave the environment PORT=<number> in.
• In the environment of the single_page_app and graphql_server add all variables that can be set and passed to the respective running app.
• add container names to all containers to ease docker exec commands.
• add a backend network for the postgres and graphql server, if not already in there

Fix the production docker-compose.yml

Have a look at how the single-page-app is compiled and made available as a static page through a simple nginx server. Make sure this works again and all environment variables are correctly passed to the now static SPA. Possibly this has to be set during compilation time?

Adjust the Readme

This issue should simplify the usage of the StarterPack greatly. Reflect that in updating the Readme accordingly.

The two code generators used for the GraphQL server and for the single page application have integration test suites that use Docker to run the tests.

The respective Docker files are more up to date than those within this Starter-Pack. Please update the files accordingly.

Expected work time: 2h

Using the data model definitions created for the Teosinte project create a working instance of ScienceDb using the ScienceDbStarterPack.

Create a new branch of this project called Teosinte.

Once you have valid and working data model definitions, put the respective JSON files into the ./data_model_definitions folder. Delete all not needed model definitions. Leave User and Role data models.

Subsequently follow the instructions as given in the README.

Try the ScienceDb instance in the browser using the following URLs:

• SPA localhost:8080
• GraphiQL localhost:3000/graphql

Report bugs and problems encountered.

Expected work time: 8h

See zendro#16

This is an issue both for the master branch of the SPA and the StarterPack. We have updated the user roles with Issue #57. However the current setup of the StarterPack still expects the role admin (not administrator) and thus does not even enable the user to see any data model in the SPA. Please fix.