Skip to content

Commit

Permalink
Update new_project.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
miklosban authored Apr 22, 2024
1 parent 026e4fc commit 70f51b6
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions official_docs/en/new_project.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,32 @@
Creating/founding a new database project
========================================

Any member of a database can create a new database project.
Any member of a database can create a new database project using the "Founding new project" form.

The new database project created will be completely independent from the current project and the founder will be its owner and sole user as long as he does not invite any new members to his project.

The steps to set up a project are as follows:

- You must give the project a unique name. This name will be the prefix name of your database tables and will be mostly seen in your browser URL.
- It is also necessary to give your project a short descriptive name that will appear in the header of our database project. This is already a translatable string, i.e. we can specify it in different languages later after the project is created.
- It is also necessary to write a detailed description of what the project is, what its purpose is. This can also be modified later.
- Give a unique name for the project. This name will be the prefix name of your database tables and will be mostly seen in your browser URL. It is strongly recommended to use a single and short word as the project name!
- It is also necessary to give a short descriptive name that will appear in the header of our database project. This is already a translatable string, i.e. we can specify it in different languages later after the project is created. It is not recommended to be too long, rather only 2-3 words.
- It is necessary to write a detailed description of what the project is, and what its purpose is. This can also be modified later.
- The possibilities to access and modify the data should be defined, which determines who can query and modify the data. In the case of closed projects, there are different levels of access to data after the project is created. This setting can be changed later.
- You need to specify the default centre of the map page, which we can also modify later on the map-related admin interface.
- Finally, you have to specify the SRID of the base map of the project (https://spatialreference.org/), which defaults to WGS84 (EPSG 4326). It is not recommended to use something else.

When the project is created, a data table is created (with the name we have given it), containing only the fields required by OBM. This will be the base table of our project. We can define arbitrary data fields for this table during project creation, but we can also do this later in our project in a similar interface.
Once the form has been completed and submitted, the project will be created in an experimental status. This is not relevant for the functioning of the project, but rather for the information of the users.

We need to specify the default center of the map page, which we can also modify later.
When the project is created, you will see a message about the creation process, in which you will see the name and password of the SQL admin user of the project. Save this. You will definitely need this.

Finally, we need to specify the SRID of the base map of the project (https://spatialreference.org/), which defaults to WGS84 (epsg 4326).
You can access the newly created project with your existing username (email) and password.

After filling in and submitting this form, the project is created with an experimental status. This is not relevant for the functioning of the project, but rather for information of the users.
When the project is created, a data table is created (with the name we have given it) containing only the fields required by OBM. This will be the base table of our project. Once the project is created, you will be able to add your fields to the base table or create additional tables in the administrative interface.

The user name and password valid for this project will also be used to access the newly created project.
After logging in to the project, several settings need to be made to make the project usable, such as setting up modules and creating forms.

After logging in to the project, a number of settings need to be made to make the project usable, such as setting up modules and creating forms.
In a nutshell, the following settings should be done:
- Set up your data table(s).
- Set up upload forms.
- Set up an SQL query.
- Set up your map interface
- Set up modules for data query (e.g. text_filter, identify_points) and visualisation (results_asStable, results_buttons, results_summary).

0 comments on commit 70f51b6

Please sign in to comment.