chairemobilite / evolution

Online survey platform for travel survey
MIT License
4 stars 9 forks source link

Add a script to setup new survey project #65

Open tahini opened 1 year ago

tahini commented 1 year ago

Project repositories can be quite complicated. To avoid to the user the hassle of creating a new project himself and adding git submodule. this repo could add a tool that bootstraps the new project.

tahini commented 1 year ago

Steps this script will need to do:

I suggest to add a template directory in this repo, with all files to create containing placeholders that can be replaced when copied with the project name and directory.

The script would receive as argument the name of the project and the path to where to create it.

samuel-duhaime commented 11 months ago

@tahini Do we want a script or a templateSurvey (or ExampleSurvey) repo with a project that people can start working on ?

tahini commented 11 months ago

The main goal of this setup task is this:

"A user should be able, with minimal effort, to have a project that they can edit and work on, and that won't be part of Evolution's git repository".

It can either be a script that will create a new project in the user's desired location, or a directory in this repo, that the user can simply copy-paste, with a README with instructions. In any case, the script will need a template somewhere, so there will be a template repo here. The script could ask questions, like survey name, with placeholders. We can even have various templates, with pre-defined home and household questions.

As long as it's easy, well-documented and useful.

samuel-duhaime commented 11 months ago

@tahini That's good, I would love to help with this issue when I have some time.